maxGraph/docs/js-api/files/shape/mxText-js.html

115 lines
66 KiB
HTML
Raw Normal View History

2012-05-21 20:32:26 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
<html><head><title>mxText</title><link rel="stylesheet" type="text/css" href="../../styles/main.css"><script language=JavaScript src="../../javascript/main.js"></script><script language=JavaScript src="../../javascript/prettify.js"></script><script language=JavaScript src="../../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.5 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
2015-11-03 17:35:20 +00:00
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxText"></a>mxText</h1><div class=CBody><p>Extends <a href="mxShape-js.html#mxShape" class=LClass id=link39 onMouseOver="ShowTip(event, 'tt1', 'link39')" onMouseOut="HideTip('tt1')">mxShape</a> to implement a text shape.&nbsp; To change vertical text from bottom to top to top to bottom, the following code can be used:</p><blockquote><pre class="prettyprint">mxText.prototype.verticalTextRotation = 90;</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="#mxText" >mxText</a></td><td class=SDescription>Extends <a href="mxShape-js.html#mxShape" class=LClass id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">mxShape</a> to implement a text shape. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxText.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxText.mxText" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">mxText</a></td><td class=SDescription>Constructs a new text shape.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxText.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxText.baseSpacingTop" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">baseSpacingTop</a></td><td class=SDescription>Specifies the spacing to be added to the top spacing. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxText.baseSpacingBottom" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">baseSpacingBottom</a></td><td class=SDescription>Specifies the spacing to be added to the bottom spacing. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxText.baseSpacingLeft" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">baseSpacingLeft</a></td><td class=SDescription>Specifies the spacing to be added to the left spacing. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxText.baseSpacingRight" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">baseSpacingRight</a></td><td class=SDescription>Specifies the spacing to be added to the right spacing. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxText.replaceLinefeeds" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">replaceLinefeeds</a></td><td class=SDescription>Specifies if linefeeds in HTML labels should be replaced with BR tags. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxText.verticalTextRotation" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">verticalTextRotation</a></td><td class=SDescription>Rotation for vertical text. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxText.ignoreClippedStringSize" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">ignoreClippedStringSize</a></td><td class=SDescription>Specifies if the string size should be measured in <a href="#mxText.updateBoundingBox" class=LFunction id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">updateBoundingBox</a> if the label is clipped and the label position is center and middle. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxText.ignoreStringSize" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">ignoreStringSize</a></td><td class=SDescription>Specifies if the actual string size should be measured. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxText.textWidthPadding" id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxText.Functions"></a>Functions</h3></div></div>
2015-06-18 15:23:41 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.mxText"></a>mxText</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function mxText(</td><td class=PParameter nowrap>value,</td></tr><tr><td></td><td class=PParameter nowrap>bounds,</td></tr><tr><td></td><td class=PParameter nowrap>align,</td></tr><tr><td></td><td class=PParameter nowrap>valign,</td></tr><tr><td></td><td class=PParameter nowrap>color,</td></tr><tr><td></td><td class=PParameter nowrap>family,</td></tr><tr><td></td><td class=PParameter nowrap>size,</td></tr><tr><td></td><td class=PParameter nowrap>fontStyle,</td></tr><tr><td></td><td class=PParameter nowrap>spacing,</td></tr><tr><td></td><td class=PParameter nowrap>spacingTop,</td></tr><tr><td></td><td class=PParameter nowrap>spacingRight,</td></tr><tr><td></td><td class=PParameter nowrap>spacingBottom,</td></tr><tr><td></td><td class=PParameter nowrap>spacingLeft,</td></tr><tr><td></td><td class=PParameter nowrap>horizontal,</td></tr><tr><td></td><td class=PParameter nowrap>background,</td></tr><tr><td></td><td class=PParameter nowrap>border,</td></tr><tr><td></td><td class=PParameter nowrap>wrap,</td></tr><tr><td></td><td class=PParameter nowrap>clipped,</td></tr><tr><td></td><td class=PParameter nowrap>overflow,</td></tr><tr><td></td><td class=PParameter nowrap>labelPadding,</td></tr><tr><td></td><td class=PParameter nowrap>textDirection</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Constructs a new text shape.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>String that represents the text to be displayed.&nbsp; This is stored in &lt;value&gt;.</td></tr><tr><td class=CDLEntry>bounds</td><td class=CDLDescription><a href="../util/mxRectangle-js.html#mxRectangle" class=LClass id=link40 onMouseOver="ShowTip(event, 'tt36', 'link40')" onMouseOut="HideTip('tt36')">mxRectangle</a> that defines the bounds.&nbsp; This is stored in <a href="mxShape-js.html#mxShape.bounds" class=LVariable id=link41 onMouseOver="ShowTip(event, 'tt37', 'link41')" onMouseOut="HideTip('tt37')">mxShape.bounds</a>.</td></tr><tr><td class=CDLEntry>align</td><td class=CDLDescription>Specifies the horizontal alignment.&nbsp; Default is &lsquo;&rsquo;.&nbsp; This is stored in &lt;align&gt;.</td></tr><tr><td class=CDLEntry>valign</td><td class=CDLDescription>Specifies the vertical alignment.&nbsp; Default is &lsquo;&rsquo;.&nbsp; This is stored in &lt;valign&gt;.</td></tr><tr><td class=CDLEntry>color</td><td class=CDLDescription>String that specifies the text color.&nbsp; Default is &lsquo;black&rsquo;.&nbsp; This is stored in &lt;color&gt;.</td></tr><tr><td class=CDLEntry>family</td><td class=CDLDescription>String that specifies the font family.&nbsp; Default is <a href="../util/mxConstants-js.html#mxConstants.DEFAULT_FONTFAMILY" class=LVariable id=link42 onMouseOver="ShowTip(event, 'tt38', 'link42')" onMouseOut="HideTip('tt38')">mxConstants.DEFAULT_FONTFAMILY</a>.&nbsp; This is stored in &lt;family&gt;.</td></tr><tr><td class=CDLEntry>size</td><td class=CDLDescription>Integer that specifies the font size.&nbsp; Default is <a href="../util/mxConstants-js.html#mxConstants.DEFAULT_FONTSIZE" class=LVariable id=link43 onMouseOver="ShowTip(event, 'tt39', 'link43')" onMouseOut="HideTip('tt39')">mxConstants.DEFAULT_FONTSIZE</a>.&nbsp; This is stored in &lt;size&gt;.</td></tr><tr><td class=CDLEntry>fontStyle</td><td class=CDLDescription>Specifies the font style.&nbsp; Default is 0.&nbsp; This is stored in &lt;fontStyle&gt;.</td></tr><tr><td class=CDLEntry>spacing</td><td class=CDLDescription>Integer that specifies the global spacing.&nbsp; Default is 2.&nbsp; This is stored in &lt;spacing&gt;.</td></tr><tr><td class=CDLEntry>spacingTop</td><td class=CDLDescription>Integer that specifies the top spacing.&nbsp; Default is 0.&
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxText.Variables"></a>Variables</h3></div></div>
2013-05-23 16:14:48 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxText.baseSpacingTop"></a>baseSpacingTop</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.baseSpacingTop</td></tr></table></blockquote><p>Specifies the spacing to be added to the top spacing.&nbsp; Default is 0.&nbsp; Use the value 5 here to get the same label positions as in mxGraph 1.x.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxText.baseSpacingBottom"></a>baseSpacingBottom</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.baseSpacingBottom</td></tr></table></blockquote><p>Specifies the spacing to be added to the bottom spacing.&nbsp; Default is 0.&nbsp; Use the value 1 here to get the same label positions as in mxGraph 1.x.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxText.baseSpacingLeft"></a>baseSpacingLeft</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.baseSpacingLeft</td></tr></table></blockquote><p>Specifies the spacing to be added to the left spacing.&nbsp; Default is 0.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxText.baseSpacingRight"></a>baseSpacingRight</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.baseSpacingRight</td></tr></table></blockquote><p>Specifies the spacing to be added to the right spacing.&nbsp; Default is 0.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxText.replaceLinefeeds"></a>replaceLinefeeds</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.replaceLinefeeds</td></tr></table></blockquote><p>Specifies if linefeeds in HTML labels should be replaced with BR tags.&nbsp; Default is true.</p></div></div></div>
2012-05-30 16:26:17 +00:00
2013-05-23 16:14:48 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxText.verticalTextRotation"></a>verticalTextRotation</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.verticalTextRotation</td></tr></table></blockquote><p>Rotation for vertical text.&nbsp; Default is -90 (bottom to top).</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-06-18 15:23:41 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxText.ignoreClippedStringSize"></a>ignoreClippedStringSize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.ignoreClippedStringSize</td></tr></table></blockquote><p>Specifies if the string size should be measured in <a href="#mxText.updateBoundingBox" class=LFunction id=link44 onMouseOver="ShowTip(event, 'tt10', 'link44')" onMouseOut="HideTip('tt10')">updateBoundingBox</a> if the label is clipped and the label position is center and middle.&nbsp; If this is true, then the bounding box will be set to &lt;bounds&gt;.&nbsp; Default is true.&nbsp; <a href="#mxText.ignoreStringSize" class=LVariable id=link45 onMouseOver="ShowTip(event, 'tt11', 'link45')" onMouseOut="HideTip('tt11')">ignoreStringSize</a> has precedence over this switch.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxText.ignoreStringSize"></a>ignoreStringSize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.ignoreStringSize</td></tr></table></blockquote><p>Specifies if the actual string size should be measured.&nbsp; If disabled the boundingBox will not ignore the actual size of the string, otherwise &lt;bounds&gt; will be used instead.&nbsp; Default is false.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2014-08-29 08:54:05 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxText.textWidthPadding"></a>textWidthPadding</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.textWidthPadding</td></tr></table></blockquote><p>Specifies the padding to be added to the text width for the bounding box.&nbsp; This is needed to make sure no clipping is applied to borders.&nbsp; Default is 4 for IE 8 standards mode and 3 for all others.</p></div></div></div>
2015-06-18 15:23:41 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxText.lastValue"></a>lastValue</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.lastValue</td></tr></table></blockquote><p>Contains the last rendered text value.&nbsp; Used for caching.</p></div></div></div>
2015-06-23 07:48:06 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxText.cacheEnabled"></a>cacheEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.cacheEnabled</td></tr></table></blockquote><p>Specifies if caching for HTML labels should be enabled.&nbsp; Default is true.</p></div></div></div>
2015-06-18 15:23:41 +00:00
2013-05-23 16:14:48 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxText.Functions"></a>Functions</h3></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.isParseVml"></a>isParseVml</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.isParseVml = function()</td></tr></table></blockquote><p>Text shapes do not contain VML markup and do not need to be parsed.&nbsp; This method returns false to speed up rendering in IE8.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.isHtmlAllowed"></a>isHtmlAllowed</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.isHtmlAllowed = function()</td></tr></table></blockquote><p>Returns true if HTML is allowed for this shape.&nbsp; This implementation returns true if the browser is not in IE8 standards mode.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.getSvgScreenOffset"></a>getSvgScreenOffset</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.getSvgScreenOffset = function()</td></tr></table></blockquote><p>Disables offset in IE9 for crisper image output.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.checkBounds"></a>checkBounds</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.checkBounds = function()</td></tr></table></blockquote><p>Returns true if the bounds are not null and all of its variables are numeric.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-06-18 15:23:41 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.paint"></a>paint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxText.prototype.paint = function(</td><td class=PParameter nowrap>c,</td></tr><tr><td></td><td class=PParameter nowrap>update</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Generic rendering code.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.redraw"></a>redraw</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.redraw = function()</td></tr></table></blockquote><p>Renders the text using the given DOM nodes.</p></div></div></div>
2015-03-05 09:43:42 +00:00
2015-11-03 17:35:20 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.apply"></a>apply</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxText.prototype.apply = function(</td><td class=PParameter nowrap>state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Extends mxShape to update the text styles.</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="../view/mxCellState-js.html#mxCellState" class=LClass id=link46 onMouseOver="ShowTip(event, 'tt40', 'link46')" onMouseOut="HideTip('tt40')">mxCellState</a> of the corresponding cell.</td></tr></table></div></div></div>
2015-06-18 15:23:41 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.getAutoDirection"></a>getAutoDirection</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.getAutoDirection = function()</td></tr></table></blockquote><p>Used to determine the automatic text direction.&nbsp; Returns <a href="../util/mxConstants-js.html#mxConstants.TEXT_DIRECTION_LTR" class=LVariable id=link47 onMouseOver="ShowTip(event, 'tt41', 'link47')" onMouseOut="HideTip('tt41')">mxConstants.TEXT_DIRECTION_LTR</a> or <a href="../util/mxConstants-js.html#mxConstants.TEXT_DIRECTION_RTL" class=LVariable id=link48 onMouseOver="ShowTip(event, 'tt42', 'link48')" onMouseOut="HideTip('tt42')">mxConstants.TEXT_DIRECTION_RTL</a> depending on the contents of &lt;value&gt;.&nbsp; This is not invoked for HTML, wrapped content or if &lt;value&gt; is a DOM node.</p></div></div></div>
2013-08-21 09:32:40 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.updateBoundingBox"></a>updateBoundingBox</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.updateBoundingBox = function()</td></tr></table></blockquote><p>Updates the &lt;boundingBox&gt; for this shape using the given node and position.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.getShapeRotation"></a>getShapeRotation</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.getShapeRotation = function()</td></tr></table></blockquote><p>Returns 0 to avoid using rotation in the canvas via updateTransform.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.getTextRotation"></a>getTextRotation</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.getTextRotation = function()</td></tr></table></blockquote><p>Returns the rotation for the text label of the corresponding shape.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.isPaintBoundsInverted"></a>isPaintBoundsInverted</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.isPaintBoundsInverted = function()</td></tr></table></blockquote><p>Inverts the bounds if &lt;mxShape.isBoundsInverted&gt; returns true or if the horizontal style is false.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.configureCanvas"></a>configureCanvas</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxText.prototype.configureCanvas = function(</td><td class=PParameter nowrap>c,</td></tr><tr><td></td><td class=PParameter nowrap>x,</td></tr><tr><td></td><td class=PParameter nowrap>y,</td></tr><tr><td></td><td class=PParameter nowrap>w,</td></tr><tr><td></td><td class=PParameter nowrap>h</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the state of the canvas for drawing the shape.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.updateVmlContainer"></a>updateVmlContainer</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.updateVmlContainer = function()</td></tr></table></blockquote><p>Sets the width and height of the container to 1px.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.redrawHtmlShape"></a>redrawHtmlShape</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.redrawHtmlShape = function()</td></tr></table></blockquote><p>Updates the HTML node(s) to reflect the latest bounds and scale.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-06-18 15:23:41 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.updateHtmlTransform"></a>updateHtmlTransform</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.updateHtmlTransform = function()</td></tr></table></blockquote><p>Returns the spacing as an <a href="../util/mxPoint-js.html#mxPoint" class=LClass id=link49 onMouseOver="ShowTip(event, 'tt30', 'link49')" onMouseOut="HideTip('tt30')">mxPoint</a>.</p></div></div></div>
2014-08-29 08:54:05 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.setInnerHtml"></a>setInnerHtml</h3><div class=CBody><p>Sets the inner HTML of the given element to the &lt;value&gt;.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.updateHtmlFilter"></a>updateHtmlFilter</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.updateHtmlFilter = function()</td></tr></table></blockquote><p>Rotated text rendering quality is bad for IE9 quirks/IE8 standards</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.updateValue"></a>updateValue</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.updateValue = function()</td></tr></table></blockquote><p>Updates the HTML node(s) to reflect the latest bounds and scale.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.updateFont"></a>updateFont</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxText.prototype.updateFont = function(</td><td class=PParameter nowrap>node</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates the HTML node(s) to reflect the latest bounds and scale.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2014-07-25 06:48:01 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.updateSize"></a>updateSize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxText.prototype.updateSize = function(</td><td class=PParameter nowrap>node,</td></tr><tr><td></td><td class=PParameter nowrap>enableWrap</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates the HTML node(s) to reflect the latest bounds and scale.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-06-18 15:23:41 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.getMargin"></a>getMargin</h3><div class=CBody><p>Returns the spacing as an <a href="../util/mxPoint-js.html#mxPoint" class=LClass id=link50 onMouseOver="ShowTip(event, 'tt30', 'link50')" onMouseOut="HideTip('tt30')">mxPoint</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2015-06-18 15:23:41 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxText.getSpacing"></a>getSpacing</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.getSpacing = function()</td></tr></table></blockquote><p>Returns the spacing as an <a href="../util/mxPoint-js.html#mxPoint" class=LClass id=link51 onMouseOver="ShowTip(event, 'tt30', 'link51')" onMouseOut="HideTip('tt30')">mxPoint</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
</div><!--Content-->
<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
2016-01-06 10:57:28 +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([9], 13);// --></script></div><!--Menu-->
<!--START_ND_TOOLTIPS-->
2015-11-03 17:35:20 +00:00
<div class=CToolTip id="tt1"><div class=CClass>Base class for all shapes. </div></div><div class=CToolTip id="tt2"><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 mxText(</td><td class=PParameter nowrap>value,</td></tr><tr><td></td><td class=PParameter nowrap>bounds,</td></tr><tr><td></td><td class=PParameter nowrap>align,</td></tr><tr><td></td><td class=PParameter nowrap>valign,</td></tr><tr><td></td><td class=PParameter nowrap>color,</td></tr><tr><td></td><td class=PParameter nowrap>family,</td></tr><tr><td></td><td class=PParameter nowrap>size,</td></tr><tr><td></td><td class=PParameter nowrap>fontStyle,</td></tr><tr><td></td><td class=PParameter nowrap>spacing,</td></tr><tr><td></td><td class=PParameter nowrap>spacingTop,</td></tr><tr><td></td><td class=PParameter nowrap>spacingRight,</td></tr><tr><td></td><td class=PParameter nowrap>spacingBottom,</td></tr><tr><td></td><td class=PParameter nowrap>spacingLeft,</td></tr><tr><td></td><td class=PParameter nowrap>horizontal,</td></tr><tr><td></td><td class=PParameter nowrap>background,</td></tr><tr><td></td><td class=PParameter nowrap>border,</td></tr><tr><td></td><td class=PParameter nowrap>wrap,</td></tr><tr><td></td><td class=PParameter nowrap>clipped,</td></tr><tr><td></td><td class=PParameter nowrap>overflow,</td></tr><tr><td></td><td class=PParameter nowrap>labelPadding,</td></tr><tr><td></td><td class=PParameter nowrap>textDirection</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Constructs a new text shape.</div></div><div class=CToolTip id="tt3"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.baseSpacingTop</td></tr></table></blockquote>Specifies the spacing to be added to the top spacing. </div></div><div class=CToolTip id="tt4"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.baseSpacingBottom</td></tr></table></blockquote>Specifies the spacing to be added to the bottom spacing. </div></div><div class=CToolTip id="tt5"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.baseSpacingLeft</td></tr></table></blockquote>Specifies the spacing to be added to the left spacing. </div></div><div class=CToolTip id="tt6"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.baseSpacingRight</td></tr></table></blockquote>Specifies the spacing to be added to the right spacing. </div></div><div class=CToolTip id="tt7"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.replaceLinefeeds</td></tr></table></blockquote>Specifies if linefeeds in HTML labels should be replaced with BR tags. </div></div><div class=CToolTip id="tt8"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.verticalTextRotation</td></tr></table></blockquote>Rotation for vertical text. </div></div><div class=CToolTip id="tt9"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.ignoreClippedStringSize</td></tr></table></blockquote>Specifies if the string size should be measured in updateBoundingBox if the label is clipped and the label position is center and middle. </div></div><div class=CToolTip id="tt10"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxText.prototype.updateBoundingBox = function()</td></tr></table></blockquote>Updates the boundingBox for this shape using the given node and position.</div></div><div class=CToolTip id="tt11"><div class=CVariable><blockquote><table border=0
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>