maxGraph/docs/js-api/files/view/mxCellRenderer-js.html

145 lines
105 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">
2017-06-27 11:43:19 +00:00
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>mxCellRenderer</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><!--
2012-05-21 20:32:26 +00:00
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
2017-06-27 11:43:19 +00:00
<!-- Generated by Natural Docs, version 1.51 -->
2012-05-21 20:32:26 +00:00
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
2018-05-17 07:19:42 +00:00
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxCellRenderer"></a>mxCellRenderer</h1><div class=CBody><p>Renders cells into a document object model.&nbsp; The <a href="#mxCellRenderer.defaultShapes" class=LVariable id=link55 onMouseOver="ShowTip(event, 'tt2', 'link55')" onMouseOut="HideTip('tt2')">defaultShapes</a> is a global map of shapename, constructor pairs that is used in all instances.&nbsp; You can get a list of all available shape names using the following code.</p><p>In general the cell renderer is in charge of creating, redrawing and destroying the shape and label associated with a cell state, as well as some other graphical objects, namely controls and overlays.&nbsp; The shape hieararchy in the display (ie. the hierarchy in which the DOM nodes appear in the document) does not reflect the cell hierarchy.&nbsp; The shapes are a (flat) sequence of shapes and labels inside the draw pane of the graph view, with some exceptions, namely the HTML labels being placed directly inside the graph container for certain browsers.</p><blockquote><pre class="prettyprint">mxLog.show();
2017-11-30 09:21:18 +00:00
for (var i in mxCellRenderer.defaultShapes)
2012-05-21 20:32:26 +00:00
{
mxLog.debug(i);
2018-05-17 07:19:42 +00:00
}</pre></blockquote><!--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="#mxCellRenderer" >mxCellRenderer</a></td><td class=SDescription>Renders cells into a document object model. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxCellRenderer.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxCellRenderer.mxCellRenderer" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">mxCellRenderer</a></td><td class=SDescription>arrow, rectangle, ellipse, rhombus, image, line, label, cylinder, swimlane, connector, actor and cloud.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxCellRenderer.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxCellRenderer.defaultShapes" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">defaultShapes</a></td><td class=SDescription>Static array that contains the globally registered shapes which are known to all instances of this class. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxCellRenderer.defaultEdgeShape" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">defaultEdgeShape</a></td><td class=SDescription>Defines the default shape for edges. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxCellRenderer.defaultVertexShape" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">defaultVertexShape</a></td><td class=SDescription>Defines the default shape for vertices. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxCellRenderer.defaultTextShape" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">defaultTextShape</a></td><td class=SDescription>Defines the default shape for labels. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxCellRenderer.legacyControlPosition" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">legacyControlPosition</a></td><td class=SDescription>Specifies if the folding icon should ignore the horizontal orientation of a swimlane. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxCellRenderer.legacySpacing" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">legacySpacing</a></td><td class=SDescription>Specifies if spacing and label position should be ignored if overflow is fill or width. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxCellRenderer.antiAlias" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">antiAlias</a></td><td class=SDescription>Anti-aliasing option for new shapes. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxCellRenderer.minSvgStrokeWidth" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">minSvgStrokeWidth</a></td><td class=SDescription>Minimum stroke width for SVG output.</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxCellRenderer.forceControlClickHandler" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">forceControlClickHandler</a></td><td class=SDescription>Specifies if the enabled state of the graph should be ignored in the control click handler (to allow folding in disabled graphs). </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxCellRenderer.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxCellRenderer.registerShape" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">registerShape</a></td><td class=SDescription>Registers the given constructor under the specified key in this instance
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.Functions"></a>Functions</h3></div></div>
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.mxCellRenderer"></a>mxCellRenderer</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function mxCellRenderer()</td></tr></table></blockquote><h4 class=CHeading>Constructs a new cell renderer with the following built-in shapes</h4><p>arrow, rectangle, ellipse, rhombus, image, line, label, cylinder, swimlane, connector, actor and cloud.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.Variables"></a>Variables</h3></div></div>
2018-05-17 07:19:42 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.defaultShapes"></a>defaultShapes</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellRenderer.defaultShapes</td></tr></table></blockquote><p>Static array that contains the globally registered shapes which are known to all instances of this class.&nbsp; For adding new shapes you should use the static <a href="#mxCellRenderer.registerShape" class=LFunction id=link56 onMouseOver="ShowTip(event, 'tt11', 'link56')" onMouseOut="HideTip('tt11')">mxCellRenderer.registerShape</a> function.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.defaultEdgeShape"></a>defaultEdgeShape</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellRenderer.prototype.defaultEdgeShape</td></tr></table></blockquote><p>Defines the default shape for edges.&nbsp; Default is <a href="../shape/mxConnector-js.html#mxConnector" class=LClass id=link57 onMouseOver="ShowTip(event, 'tt51', 'link57')" onMouseOut="HideTip('tt51')">mxConnector</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.defaultVertexShape"></a>defaultVertexShape</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellRenderer.prototype.defaultVertexShape</td></tr></table></blockquote><p>Defines the default shape for vertices.&nbsp; Default is <a href="../shape/mxRectangleShape-js.html#mxRectangleShape" class=LClass id=link58 onMouseOver="ShowTip(event, 'tt52', 'link58')" onMouseOut="HideTip('tt52')">mxRectangleShape</a>.</p></div></div></div>
2017-11-30 09:21:18 +00:00
2018-05-17 07:19:42 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.defaultTextShape"></a>defaultTextShape</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellRenderer.prototype.defaultTextShape</td></tr></table></blockquote><p>Defines the default shape for labels.&nbsp; Default is <a href="../shape/mxText-js.html#mxText" class=LClass id=link59 onMouseOver="ShowTip(event, 'tt53', 'link59')" onMouseOut="HideTip('tt53')">mxText</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.legacyControlPosition"></a>legacyControlPosition</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellRenderer.prototype.legacyControlPosition</td></tr></table></blockquote><p>Specifies if the folding icon should ignore the horizontal orientation of a swimlane.&nbsp; Default is true.</p></div></div></div>
2013-05-23 16:14:48 +00:00
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.legacySpacing"></a>legacySpacing</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellRenderer.prototype.legacySpacing</td></tr></table></blockquote><p>Specifies if spacing and label position should be ignored if overflow is fill or width.&nbsp; Default is true for backwards compatiblity.</p></div></div></div>
2014-11-28 08:55:09 +00:00
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.antiAlias"></a>antiAlias</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellRenderer.prototype.antiAlias</td></tr></table></blockquote><p>Anti-aliasing option for new shapes.&nbsp; Default is true.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.minSvgStrokeWidth"></a>minSvgStrokeWidth</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellRenderer.prototype.minSvgStrokeWidth</td></tr></table></blockquote><p>Minimum stroke width for SVG output.</p></div></div></div>
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.forceControlClickHandler"></a>forceControlClickHandler</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellRenderer.prototype.forceControlClickHandler</td></tr></table></blockquote><p>Specifies if the enabled state of the graph should be ignored in the control click handler (to allow folding in disabled graphs).&nbsp; Default is false.</p></div></div></div>
2016-05-09 10:56:11 +00:00
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.Functions"></a>Functions</h3></div></div>
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.registerShape"></a>registerShape</h3><div class=CBody><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>mxCellRenderer.registerShape = function(</td><td class="PParameter prettyprint " nowrap>key,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>shape</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Registers the given constructor under the specified key in this instance of the renderer.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">mxCellRenderer.registerShape(mxConstants.SHAPE_RECTANGLE, mxRectangleShape);</pre></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>key</td><td class=CDLDescription>String representing the shape name.</td></tr><tr><td class=CDLEntry>shape</td><td class=CDLDescription>Constructor of the <a href="../shape/mxShape-js.html#mxShape" class=LClass id=link60 onMouseOver="ShowTip(event, 'tt28', 'link60')" onMouseOut="HideTip('tt28')">mxShape</a> subclass.</td></tr></table></div></div></div>
2013-05-23 16:14:48 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.initializeShape"></a>initializeShape</h3><div class=CBody><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>mxCellRenderer.prototype.initializeShape = function(</td><td class="PParameter prettyprint " nowrap>state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Initializes the shape in the given state by calling its init method with the correct container after configuring it using <a href="#mxCellRenderer.configureShape" class=LFunction id=link61 onMouseOver="ShowTip(event, 'tt13', 'link61')" onMouseOut="HideTip('tt13')">configureShape</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link62 onMouseOver="ShowTip(event, 'tt26', 'link62')" onMouseOut="HideTip('tt26')">mxCellState</a> for which the shape should be initialized.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.createShape"></a>createShape</h3><div class=CBody><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>mxCellRenderer.prototype.createShape = function(</td><td class="PParameter prettyprint " nowrap>state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Creates and returns the shape for the given cell state.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link63 onMouseOver="ShowTip(event, 'tt26', 'link63')" onMouseOut="HideTip('tt26')">mxCellState</a> for which the shape should be created.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.createIndicatorShape"></a>createIndicatorShape</h3><div class=CBody><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>mxCellRenderer.prototype.createIndicatorShape = function(</td><td class="PParameter prettyprint " nowrap>state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Creates the indicator shape for the given cell state.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link64 onMouseOver="ShowTip(event, 'tt26', 'link64')" onMouseOut="HideTip('tt26')">mxCellState</a> for which the indicator shape should be created.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.getShape"></a>getShape</h3><div class=CBody><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>mxCellRenderer.prototype.getShape = function(</td><td class="PParameter prettyprint " nowrap>name</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the shape for the given name from <a href="#mxCellRenderer.defaultShapes" class=LVariable id=link65 onMouseOver="ShowTip(event, 'tt2', 'link65')" onMouseOut="HideTip('tt2')">defaultShapes</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.getShapeConstructor"></a>getShapeConstructor</h3><div class=CBody><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>mxCellRenderer.prototype.getShapeConstructor = function(</td><td class="PParameter prettyprint " nowrap>state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the constructor to be used for creating the shape.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.configureShape"></a>configureShape</h3><div class=CBody><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>mxCellRenderer.prototype.configureShape = function(</td><td class="PParameter prettyprint " nowrap>state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Configures the shape for the given cell state.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link66 onMouseOver="ShowTip(event, 'tt26', 'link66')" onMouseOut="HideTip('tt26')">mxCellState</a> for which the shape should be configured.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.postConfigureShape"></a>postConfigureShape</h3><div class=CBody><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>mxCellRenderer.prototype.postConfigureShape = function(</td><td class="PParameter prettyprint " nowrap>state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Replaces any reserved words used for attributes, eg. inherit, indicated or swimlane for colors in the shape for the given state.&nbsp; This implementation resolves these keywords on the fill, stroke and gradient color keys.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-11-24 16:16:54 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.checkPlaceholderStyles"></a>checkPlaceholderStyles</h3><div class=CBody><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>mxCellRenderer.prototype.checkPlaceholderStyles = function(</td><td class="PParameter prettyprint " nowrap>state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Resolves special keywords &lsquo;inherit&rsquo;, &lsquo;indicated&rsquo; and &lsquo;swimlane&rsquo; and sets the respective color on the shape.</p></div></div></div>
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.resolveColor"></a>resolveColor</h3><div class=CBody><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>mxCellRenderer.prototype.resolveColor = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>field,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>key</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Resolves special keywords &lsquo;inherit&rsquo;, &lsquo;indicated&rsquo; and &lsquo;swimlane&rsquo; and sets the respective color on the shape.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.getLabelValue"></a>getLabelValue</h3><div class=CBody><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>mxCellRenderer.prototype.getLabelValue = function(</td><td class="PParameter prettyprint " nowrap>state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the value to be used for the label.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link67 onMouseOver="ShowTip(event, 'tt26', 'link67')" onMouseOut="HideTip('tt26')">mxCellState</a> for which the label should be created.</td></tr></table></div></div></div>
2013-05-23 16:14:48 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.createLabel"></a>createLabel</h3><div class=CBody><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>mxCellRenderer.prototype.createLabel = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>value</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Creates the label for the given cell state.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link68 onMouseOver="ShowTip(event, 'tt26', 'link68')" onMouseOut="HideTip('tt26')">mxCellState</a> for which the label should be created.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.initializeLabel"></a>initializeLabel</h3><div class=CBody><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>mxCellRenderer.prototype.initializeLabel = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>shape</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Initiailzes the label with a suitable container.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link69 onMouseOver="ShowTip(event, 'tt26', 'link69')" onMouseOut="HideTip('tt26')">mxCellState</a> whose label should be initialized.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.createCellOverlays"></a>createCellOverlays</h3><div class=CBody><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>mxCellRenderer.prototype.createCellOverlays = function(</td><td class="PParameter prettyprint " nowrap>state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Creates the actual shape for showing the overlay for the given cell state.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link70 onMouseOver="ShowTip(event, 'tt26', 'link70')" onMouseOut="HideTip('tt26')">mxCellState</a> for which the overlay should be created.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.initializeOverlay"></a>initializeOverlay</h3><div class=CBody><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>mxCellRenderer.prototype.initializeOverlay = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>overlay</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Initializes the given overlay.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link71 onMouseOver="ShowTip(event, 'tt26', 'link71')" onMouseOut="HideTip('tt26')">mxCellState</a> for which the overlay should be created.</td></tr><tr><td class=CDLEntry>overlay</td><td class=CDLDescription><a href="../shape/mxImageShape-js.html#mxImageShape" class=LClass id=link72 onMouseOver="ShowTip(event, 'tt54', 'link72')" onMouseOut="HideTip('tt54')">mxImageShape</a> that represents the overlay.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.installOverlayListeners"></a>installOverlayListeners</h3><div class=CBody><p>Installs the listeners for the given <a href="mxCellState-js.html#mxCellState" class=LClass id=link73 onMouseOver="ShowTip(event, 'tt26', 'link73')" onMouseOut="HideTip('tt26')">mxCellState</a>, <a href="mxCellOverlay-js.html#mxCellOverlay" class=LClass id=link74 onMouseOver="ShowTip(event, 'tt27', 'link74')" onMouseOut="HideTip('tt27')">mxCellOverlay</a> and <a href="../shape/mxShape-js.html#mxShape" class=LClass id=link75 onMouseOver="ShowTip(event, 'tt28', 'link75')" onMouseOut="HideTip('tt28')">mxShape</a> that represents the overlay.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.createControl"></a>createControl</h3><div class=CBody><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>mxCellRenderer.prototype.createControl = function(</td><td class="PParameter prettyprint " nowrap>state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Creates the control for the given cell state.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link76 onMouseOver="ShowTip(event, 'tt26', 'link76')" onMouseOut="HideTip('tt26')">mxCellState</a> for which the control should be created.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.createControlClickHandler"></a>createControlClickHandler</h3><div class=CBody><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>mxCellRenderer.prototype.createControlClickHandler = function(</td><td class="PParameter prettyprint " nowrap>state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Hook for creating the click handler for the folding icon.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link77 onMouseOver="ShowTip(event, 'tt26', 'link77')" onMouseOut="HideTip('tt26')">mxCellState</a> whose control click handler should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.initControl"></a>initControl</h3><div class=CBody><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>mxCellRenderer.prototype.initControl = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>control,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>handleEvents,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>clickHandler</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Initializes the given control and returns the corresponding DOM node.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link78 onMouseOver="ShowTip(event, 'tt26', 'link78')" onMouseOut="HideTip('tt26')">mxCellState</a> for which the control should be initialized.</td></tr><tr><td class=CDLEntry>control</td><td class=CDLDescription><a href="../shape/mxShape-js.html#mxShape" class=LClass id=link79 onMouseOver="ShowTip(event, 'tt28', 'link79')" onMouseOut="HideTip('tt28')">mxShape</a> to be initialized.</td></tr><tr><td class=CDLEntry>handleEvents</td><td class=CDLDescription>Boolean indicating if mousedown and mousemove should fire events via the graph.</td></tr><tr><td class=CDLEntry>clickHandler</td><td class=CDLDescription>Optional function to implement clicks on the control.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.isShapeEvent"></a>isShapeEvent</h3><div class=CBody><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>mxCellRenderer.prototype.isShapeEvent = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>evt</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the event is for the shape of the given state.&nbsp; This implementation always returns true.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link80 onMouseOver="ShowTip(event, 'tt26', 'link80')" onMouseOut="HideTip('tt26')">mxCellState</a> whose shape fired the event.</td></tr><tr><td class=CDLEntry>evt</td><td class=CDLDescription>Mouse event which was fired.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.isLabelEvent"></a>isLabelEvent</h3><div class=CBody><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>mxCellRenderer.prototype.isLabelEvent = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>evt</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the event is for the label of the given state.&nbsp; This implementation always returns true.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link81 onMouseOver="ShowTip(event, 'tt26', 'link81')" onMouseOut="HideTip('tt26')">mxCellState</a> whose label fired the event.</td></tr><tr><td class=CDLEntry>evt</td><td class=CDLDescription>Mouse event which was fired.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.installListeners"></a>installListeners</h3><div class=CBody><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>mxCellRenderer.prototype.installListeners = function(</td><td class="PParameter prettyprint " nowrap>state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Installs the event listeners for the given cell state.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link82 onMouseOver="ShowTip(event, 'tt26', 'link82')" onMouseOut="HideTip('tt26')">mxCellState</a> for which the event listeners should be isntalled.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.redrawLabel"></a>redrawLabel</h3><div class=CBody><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>mxCellRenderer.prototype.redrawLabel = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>forced</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Redraws the label for the given cell state.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link83 onMouseOver="ShowTip(event, 'tt26', 'link83')" onMouseOut="HideTip('tt26')">mxCellState</a> whose label should be redrawn.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.isTextShapeInvalid"></a>isTextShapeInvalid</h3><div class=CBody><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>mxCellRenderer.prototype.isTextShapeInvalid = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>shape</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the style for the text shape has changed.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link84 onMouseOver="ShowTip(event, 'tt26', 'link84')" onMouseOut="HideTip('tt26')">mxCellState</a> whose label should be checked.</td></tr><tr><td class=CDLEntry>shape</td><td class=CDLDescription><a href="../shape/mxText-js.html#mxText" class=LClass id=link85 onMouseOver="ShowTip(event, 'tt53', 'link85')" onMouseOut="HideTip('tt53')">mxText</a> shape to be checked.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.redrawLabelShape"></a>redrawLabelShape</h3><div class=CBody><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>mxCellRenderer.prototype.redrawLabelShape = function(</td><td class="PParameter prettyprint " nowrap>shape</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Called to invoked redraw on the given text shape.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>shape</td><td class=CDLDescription><a href="../shape/mxText-js.html#mxText" class=LClass id=link86 onMouseOver="ShowTip(event, 'tt53', 'link86')" onMouseOut="HideTip('tt53')">mxText</a> shape to be redrawn.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.getTextScale"></a>getTextScale</h3><div class=CBody><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>mxCellRenderer.prototype.getTextScale = function(</td><td class="PParameter prettyprint " nowrap>state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the scaling used for the label of the given state</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link87 onMouseOver="ShowTip(event, 'tt26', 'link87')" onMouseOut="HideTip('tt26')">mxCellState</a> whose label scale should be returned.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.getLabelBounds"></a>getLabelBounds</h3><div class=CBody><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>mxCellRenderer.prototype.getLabelBounds = function(</td><td class="PParameter prettyprint " nowrap>state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the bounds to be used to draw the label of the given state.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link88 onMouseOver="ShowTip(event, 'tt26', 'link88')" onMouseOut="HideTip('tt26')">mxCellState</a> whose label bounds should be returned.</td></tr></table></div></div></div>
2015-03-13 08:29:11 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.rotateLabelBounds"></a>rotateLabelBounds</h3><div class=CBody><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>mxCellRenderer.prototype.rotateLabelBounds = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>bounds</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds the shape rotation to the given label bounds and applies the alignment and offsets.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link89 onMouseOver="ShowTip(event, 'tt26', 'link89')" onMouseOut="HideTip('tt26')">mxCellState</a> whose label bounds should be rotated.</td></tr><tr><td class=CDLEntry>bounds</td><td class=CDLDescription><a href="../util/mxRectangle-js.html#mxRectangle" class=LClass id=link90 onMouseOver="ShowTip(event, 'tt55', 'link90')" onMouseOut="HideTip('tt55')">mxRectangle</a> the rectangle to be rotated.</td></tr></table></div></div></div>
2015-11-03 17:35:20 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.redrawCellOverlays"></a>redrawCellOverlays</h3><div class=CBody><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>mxCellRenderer.prototype.redrawCellOverlays = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>forced</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Redraws the overlays for the given cell state.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link91 onMouseOver="ShowTip(event, 'tt26', 'link91')" onMouseOut="HideTip('tt26')">mxCellState</a> whose overlays should be redrawn.</td></tr></table></div></div></div>
2016-04-06 08:10:17 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.redrawControl"></a>redrawControl</h3><div class=CBody><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>mxCellRenderer.prototype.redrawControl = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>forced</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Redraws the control for the given cell state.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link92 onMouseOver="ShowTip(event, 'tt26', 'link92')" onMouseOut="HideTip('tt26')">mxCellState</a> whose control should be redrawn.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.getControlBounds"></a>getControlBounds</h3><div class=CBody><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>mxCellRenderer.prototype.getControlBounds = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>w,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>h</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the bounds to be used to draw the control (folding icon) of the given state.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.insertStateAfter"></a>insertStateAfter</h3><div class=CBody><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>mxCellRenderer.prototype.insertStateAfter = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>node,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>htmlNode</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Inserts the given array of <a href="../shape/mxShape-js.html#mxShape" class=LClass id=link93 onMouseOver="ShowTip(event, 'tt28', 'link93')" onMouseOut="HideTip('tt28')">mxShapes</a> after the given nodes in the DOM.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>shapes</td><td class=CDLDescription>Array of <a href="../shape/mxShape-js.html#mxShape" class=LClass id=link94 onMouseOver="ShowTip(event, 'tt28', 'link94')" onMouseOut="HideTip('tt28')">mxShapes</a> to be inserted.</td></tr><tr><td class=CDLEntry>node</td><td class=CDLDescription>Node in &lt;drawPane&gt; after which the shapes should be inserted.</td></tr><tr><td class=CDLEntry>htmlNode</td><td class=CDLDescription>Node in the graph container after which the shapes should be inserted that will not go into the &lt;drawPane&gt; (eg.&nbsp; HTML labels without foreignObjects).</td></tr></table></div></div></div>
2017-11-24 16:16:54 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.getShapesForState"></a>getShapesForState</h3><div class=CBody><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>mxCellRenderer.prototype.getShapesForState = function(</td><td class="PParameter prettyprint " nowrap>state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the <a href="../shape/mxShape-js.html#mxShape" class=LClass id=link95 onMouseOver="ShowTip(event, 'tt28', 'link95')" onMouseOut="HideTip('tt28')">mxShapes</a> for the given cell state in the order in which they should appear in the DOM.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link96 onMouseOver="ShowTip(event, 'tt26', 'link96')" onMouseOut="HideTip('tt26')">mxCellState</a> whose shapes should be returned.</td></tr></table></div></div></div>
2013-10-28 08:56:36 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.redraw"></a>redraw</h3><div class=CBody><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>mxCellRenderer.prototype.redraw = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>force,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>rendering</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates the bounds or points and scale of the shapes for the given cell state.&nbsp; This is called in mxGraphView.validatePoints as the last step of updating all cells.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link97 onMouseOver="ShowTip(event, 'tt26', 'link97')" onMouseOut="HideTip('tt26')">mxCellState</a> for which the shapes should be updated.</td></tr><tr><td class=CDLEntry>force</td><td class=CDLDescription>Optional boolean that specifies if the cell should be reconfiured and redrawn without any additional checks.</td></tr><tr><td class=CDLEntry>rendering</td><td class=CDLDescription>Optional boolean that specifies if the cell should actually be drawn into the DOM.&nbsp; If this is false then redraw and/or reconfigure will not be called on the shape.</td></tr></table></div></div></div>
2013-10-28 08:56:36 +00:00
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.redrawShape"></a>redrawShape</h3><div class=CBody><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>mxCellRenderer.prototype.redrawShape = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>force,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>rendering</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Redraws the shape for the given cell state.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link98 onMouseOver="ShowTip(event, 'tt26', 'link98')" onMouseOut="HideTip('tt26')">mxCellState</a> whose label should be redrawn.</td></tr></table></div></div></div>
2013-10-28 08:56:36 +00:00
2017-11-24 16:16:54 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.doRedrawShape"></a>doRedrawShape</h3><div class=CBody><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>mxCellRenderer.prototype.doRedrawShape = function(</td><td class="PParameter prettyprint " nowrap>state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Invokes redraw on the shape of the given state.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2017-08-28 09:54:36 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.isShapeInvalid"></a>isShapeInvalid</h3><div class=CBody><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>mxCellRenderer.prototype.isShapeInvalid = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>shape</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given shape must be repainted.</p></div></div></div>
2018-05-17 07:19:42 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCellRenderer.destroy"></a>destroy</h3><div class=CBody><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>mxCellRenderer.prototype.destroy = function(</td><td class="PParameter prettyprint " nowrap>state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Destroys the shapes associated with the given cell state.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="mxCellState-js.html#mxCellState" class=LClass id=link99 onMouseOver="ShowTip(event, 'tt26', 'link99')" onMouseOut="HideTip('tt26')">mxCellState</a> for which the shapes should be destroyed.</td></tr></table></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-->
2018-05-17 07:19:42 +00:00
<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/mxHandle-js.html">mxHandle</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/mxPopupMenuHandler-js.html">mxPopupMenuHandler</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></di
2012-05-21 20:32:26 +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([11], 13);// --></script></div><!--Menu-->
<!--START_ND_TOOLTIPS-->
2018-05-17 07:19:42 +00:00
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">function mxCellRenderer()</td></tr></table></blockquote>arrow, rectangle, ellipse, rhombus, image, line, label, cylinder, swimlane, connector, actor and cloud.</div></div><div class=CToolTip id="tt2"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellRenderer.defaultShapes</td></tr></table></blockquote>Static array that contains the globally registered shapes which are known to all instances of this class. </div></div><div class=CToolTip id="tt3"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellRenderer.prototype.defaultEdgeShape</td></tr></table></blockquote>Defines the default shape for edges. </div></div><div class=CToolTip id="tt4"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellRenderer.prototype.defaultVertexShape</td></tr></table></blockquote>Defines the default shape for vertices. </div></div><div class=CToolTip id="tt5"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellRenderer.prototype.defaultTextShape</td></tr></table></blockquote>Defines the default shape for labels. </div></div><div class=CToolTip id="tt6"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellRenderer.prototype.legacyControlPosition</td></tr></table></blockquote>Specifies if the folding icon should ignore the horizontal orientation of a swimlane. </div></div><div class=CToolTip id="tt7"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellRenderer.prototype.legacySpacing</td></tr></table></blockquote>Specifies if spacing and label position should be ignored if overflow is fill or width. </div></div><div class=CToolTip id="tt8"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellRenderer.prototype.antiAlias</td></tr></table></blockquote>Anti-aliasing option for new shapes. </div></div><div class=CToolTip id="tt9"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellRenderer.prototype.minSvgStrokeWidth</td></tr></table></blockquote>Minimum stroke width for SVG output.</div></div><div class=CToolTip id="tt10"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCellRenderer.prototype.forceControlClickHandler</td></tr></table></blockquote>Specifies if the enabled state of the graph should be ignored in the control click handler (to allow folding in disabled graphs). </div></div><div class=CToolTip id="tt11"><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>mxCellRenderer.registerShape = function(</td><td class="PParameter prettyprint " nowrap>key,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>shape</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Registers the given constructor under the specified key in this instance of the renderer.</div></div><div class=CToolTip id="tt12"><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>mxCellRenderer.prototype.initializeShape = function(</td><td class="PParameter prettyprint " nowrap>state</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Initializes th
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>