UNPKG

create-gojs-kit

Version:

A CLI for downloading GoJS samples, extensions, and docs

429 lines 127 kB
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><link rel="stylesheet" href="../../assets/css/style.css"/><link rel="preconnect" href="https://rsms.me/"/><link rel="stylesheet" href="https://rsms.me/inter/inter.css"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TextBlock | GoJS API</title><meta name="description" content="Documentation for GoJS API"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script type="text/javascript">// formerly in api.js
  var hash = null;
  function changeHash() {
      var panels = document.getElementsByClassName("tsd-panel");
      for (let i = 0; i < panels.length; i++) {
          var p = panels[i];
          p.classList.remove("targeted");
      }
      hash = window.location.hash.slice(1);
      if (hash) {
          var elt = document.getElementById(hash);
          if (elt) elt.parentNode.classList.add("targeted");
      }
  }
  document.addEventListener("DOMContentLoaded", changeHash);
  window.addEventListener("hashchange", changeHash);</script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header><nav id="navTop" class="w-full h-[var(--topnav-h)] z-30 bg-[var(--color-background-secondary)] border-b border-b-[var(--color-accent)]"><div class="max-w-screen-xl mx-auto flex flex-wrap items-start justify-between px-4"><a class="!text-white bg-nwoods-primary font-bold !leading-[calc(var(--topnav-h)_-_1px)] my-0 px-2 text-4xl lg:text-5xl logo" href="../../index.html">GoJS</a><div class="relative"><button id="topnavButton" class="h-[calc(var(--topnav-h)_-_1px)] px-2 m-0 text-[var(--color-text)] bg-inherit shadow-none md:hidden hover:!bg-inherit hover:!text-nwoods-accent hover:!shadow-none" aria-label="Navigation"><svg class="h-7 w-7 block" aria-hidden="true" fill="none" stroke="currentColor" stroke-width="2" viewBox="0 0 24 24"><path d="M3.75 6.75h16.5M3.75 12h16.5m-16.5 5.25h16.5" stroke-linecap="round" stroke-linejoin="round"></path></svg></button><div id="topnavList" class="hidden md:block"><div class="absolute right-0 z-30 flex flex-col items-end rounded border border-[var(--color-accent)] p-4 pl-12 shadow bg-[var(--color-background-secondary)] text-[var(--color-text)] font-semibold
                        md:flex-row md:space-x-4 md:items-start md:border-0 md:p-0 md:shadow-none md:!bg-inherit"><a href="../../learn/index.html">Learn</a><a href="../../samples/index.html">Samples</a><a href="../../intro/index.html">Intro</a><a class="active" href="../../api/index.html">API</a><a href="../../download.html">Download</a><a href="https://forum.nwoods.com/c/gojs/11" target="_blank" rel="noopener">Forum</a><a href="https://nwoods.com/contact.html" target="_blank" rel="noopener" id="contactBtn">Contact</a><a href="https://nwoods.com/sales/index.html" target="_blank" rel="noopener" id="buyBtn">Buy</a></div></div></div></div></nav><script>window.addEventListener("DOMContentLoaded", function () {
    // topnav
    var topButton = document.getElementById("topnavButton");
    var topnavList = document.getElementById("topnavList");
    if (topButton && topnavList) {
      topButton.addEventListener("click", function (e) {
        topnavList
          .classList
          .toggle("hidden");
        e.stopPropagation();
      });
      document.addEventListener("click", function (e) {
        // if the clicked element isn't the list, close the list
        if (!topnavList.classList.contains("hidden") && !e.target.closest("#topnavList")) {
          topButton.click();
        }
      });

      // set active <a> element
      // done via active tag below, always API
    }
  });</script><div class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><div id="tsd-search-help"><code class="!text-lg">/</code> to search</div><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">GoJS API</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><div class="flex w-full max-w-screen-xl mx-auto px-2 items-center justify-between"><div><ul class="tsd-breadcrumb"><li><a href="../index.html">GoJS API</a></li><li><a href="TextBlock.html">TextBlock</a></li></ul><h1 class="flex items-center">Class TextBlock</h1></div><div class="text-xs"><b>GoJS</b>® Diagramming Components<br/>version 3.1.0<br/>by <a href="https://nwoods.com/">Northwoods Software®</a></div></div></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#TextBlock">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="GraphObject.html" class="tsd-signature-type tsd-kind-class">GraphObject</a><ul class="tsd-hierarchy"><li><span class="target">TextBlock</span></li></ul></li></ul></section><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A TextBlock is a <a href="GraphObject.html" class="tsd-kind-class">GraphObject</a> that displays a <a href="TextBlock.html#text" class="tsd-kind-accessor">text</a> string in a given <a href="TextBlock.html#font" class="tsd-kind-accessor">font</a>.</p>
<p>The size and appearance of the text is specified by <a href="TextBlock.html#font" class="tsd-kind-accessor">font</a>,
which takes a well-formed CSS string as its value.
The order of the CSS properties given is important for cross-browser compatibility,
and should be given in this order:</p>
<p><em>&quot;font-style font-variant font-weight font-size font-family&quot;</em></p>
<p>For example, &quot;Italic small-caps bold 32px Georgia, Serif&quot; is a valid font string
using every CSS font property. Note that not all browsers may support every property.</p>
<p>Text is drawn using the <a href="TextBlock.html#stroke" class="tsd-kind-accessor">stroke</a> brush, which may be any CSS color string or a <a href="Brush.html" class="tsd-kind-class">Brush</a>.</p>
<p>Some created TextBlocks:</p>
<pre><code class="language-js"><span class="hl-0">// A TextBlock with text and stroke properties set:</span><br/><span class="hl-1">new</span><span class="hl-2"> </span><span class="hl-4">go</span><span class="hl-2">.</span><span class="hl-5">TextBlock</span><span class="hl-2">({ </span><span class="hl-4">text:</span><span class="hl-2"> </span><span class="hl-6">&quot;Hello World&quot;</span><span class="hl-2">, </span><span class="hl-4">stroke:</span><span class="hl-2"> </span><span class="hl-6">&quot;gray&quot;</span><span class="hl-2"> })</span><br/><span class="hl-0">// Alternatively:</span><br/><span class="hl-1">new</span><span class="hl-2"> </span><span class="hl-4">go</span><span class="hl-2">.</span><span class="hl-5">TextBlock</span><span class="hl-2">(</span><span class="hl-6">&quot;Hello World&quot;</span><span class="hl-2">, { </span><span class="hl-4">stroke:</span><span class="hl-2"> </span><span class="hl-6">&quot;gray&quot;</span><span class="hl-2"> })</span>
</code><button>Copy</button></pre>
<p>TextBlocks typically receive a natural size based on their text and font strings,
but often a width is given in order to cause the text to wrap at a certain place.
In order for wrapping to occur, the <a href="TextBlock.html#wrap" class="tsd-kind-accessor">wrap</a> property must not be <a href="Wrap.html#None" class="tsd-kind-enum-member">Wrap.None</a>.</p>
<p>TextBlocks can be edited by users using the <a href="TextEditingTool.html" class="tsd-kind-class">TextEditingTool</a>.
The <a href="HTMLInfo.html" class="tsd-kind-class">HTMLInfo</a> that a given TextBlock uses as its text editor can be customized
by setting the <a href="TextBlock.html#textEditor" class="tsd-kind-accessor">textEditor</a> property. For an example of custom text editing tool use,
see the <a href="../../samples/customTextEditingTool.html">Custom TextEditingTool Sample</a>.</p>
<p class="boxread">
For examples of TextBlock possibilities and functionality,
see the <a href="../../intro/textBlocks.html">Introduction page on TextBlocks</a>.</div></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="true" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="TextBlock.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="TextBlock.html#choices" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>choices</span></a>
<a href="TextBlock.html#editable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>editable</span></a>
<a href="TextBlock.html#errorFunction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>error<wbr/>Function</span></a>
<a href="TextBlock.html#flip" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>flip</span></a>
<a href="TextBlock.html#font" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>font</span></a>
<a href="TextBlock.html#formatting" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>formatting</span></a>
<a href="TextBlock.html#graduatedEnd" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>graduated<wbr/>End</span></a>
<a href="TextBlock.html#graduatedFunction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>graduated<wbr/>Function</span></a>
<a href="TextBlock.html#graduatedSkip" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>graduated<wbr/>Skip</span></a>
<a href="TextBlock.html#graduatedStart" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>graduated<wbr/>Start</span></a>
<a href="TextBlock.html#interval" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>interval</span></a>
<a href="TextBlock.html#isMultiline" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Multiline</span></a>
<a href="TextBlock.html#isOverflowed" class="tsd-index-link"><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><g id="subicon-R,#FF4D4D"><rect fill="var(--color-icon-background)" width="28" height="28" rx="14"></rect><path transform="translate(2, 2)" fill="none" stroke-width="1.5" stroke="var(--color-text)" d="M16.5 10.5V6.75a4.5 4.5 0 1 0-9 0v3.75m-.75 11.25h10.5a2.25 2.25 0 0 0 2.25-2.25v-6.75a2.25 2.25 0 0 0-2.25-2.25H6.75a2.25 2.25 0 0 0-2.25 2.25v6.75a2.25 2.25 0 0 0 2.25 2.25Z" stroke-linecap="round" stroke-linejoin="round"></path></g></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Overflowed</span></a>
<a href="TextBlock.html#isStrikethrough" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Strikethrough</span></a>
<a href="TextBlock.html#isUnderline" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Underline</span></a>
<a href="TextBlock.html#letterSpacing" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>letter<wbr/>Spacing</span></a>
<a href="TextBlock.html#lineCount" class="tsd-index-link"><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF4D4D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>line<wbr/>Count</span></a>
<a href="TextBlock.html#lineHeight" class="tsd-index-link"><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF4D4D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>line<wbr/>Height</span></a>
<a href="TextBlock.html#maxLines" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>max<wbr/>Lines</span></a>
<a href="TextBlock.html#naturalBounds" class="tsd-index-link"><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF4D4D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>natural<wbr/>Bounds</span></a>
<a href="TextBlock.html#overflow" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>overflow</span></a>
<a href="TextBlock.html#spacingAbove" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>spacing<wbr/>Above</span></a>
<a href="TextBlock.html#spacingBelow" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>spacing<wbr/>Below</span></a>
<a href="TextBlock.html#stroke" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>stroke</span></a>
<a href="TextBlock.html#text" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>text</span></a>
<a href="TextBlock.html#textAlign" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>text<wbr/>Align</span></a>
<a href="TextBlock.html#textEdited" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>text<wbr/>Edited</span></a>
<a href="TextBlock.html#textEditor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>text<wbr/>Editor</span></a>
<a href="TextBlock.html#textValidation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>text<wbr/>Validation</span></a>
<a href="TextBlock.html#verticalAlignment" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>vertical<wbr/>Alignment</span></a>
<a href="TextBlock.html#wordSpacing" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>word<wbr/>Spacing</span></a>
<a href="TextBlock.html#wrap" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>wrap</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="TextBlock.html#getBaseline" class="tsd-index-link"><svg class="static tsd-subicon" viewBox="0 0 28 28"><g id="subicon-S,#FF4DB8"><rect fill="var(--color-icon-background)" width="28" height="28" rx="14"></rect><path transform="translate(2, 2)" fill="none" stroke-width="1.5" stroke="var(--color-text)" d="M5.25 8.25h15m-16.5 7.5h15m-1.8-13.5-3.9 19.5m-2.1-19.5-3.9 19.5" stroke-linecap="round" stroke-linejoin="round"></path></g></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Baseline</span></a>
<a href="TextBlock.html#getUnderline" class="tsd-index-link"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF4DB8"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Underline</span></a>
<a href="TextBlock.html#isValidFont" class="tsd-index-link"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF4DB8"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Valid<wbr/>Font</span></a>
<a href="TextBlock.html#setBaseline" class="tsd-index-link"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF4DB8"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Baseline</span></a>
<a href="TextBlock.html#setUnderline" class="tsd-index-link"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF4DB8"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Underline</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="TextBlock.html#FormatNone" class="tsd-index-link deprecated"><svg class="static tsd-subicon" viewBox="0 0 28 28"><g id="subicon-S,#FF984D"><rect fill="var(--color-icon-background)" width="28" height="28" rx="14"></rect><path transform="translate(2, 2)" fill="none" stroke-width="1.5" stroke="var(--color-text)" d="M5.25 8.25h15m-16.5 7.5h15m-1.8-13.5-3.9 19.5m-2.1-19.5-3.9 19.5" stroke-linecap="round" stroke-linejoin="round"></path></g></svg><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><g id="subicon-R,#FF984D"><rect fill="var(--color-icon-background)" width="28" height="28" rx="14"></rect><path transform="translate(2, 2)" fill="none" stroke-width="1.5" stroke="var(--color-text)" d="M16.5 10.5V6.75a4.5 4.5 0 1 0-9 0v3.75m-.75 11.25h10.5a2.25 2.25 0 0 0 2.25-2.25v-6.75a2.25 2.25 0 0 0-2.25-2.25H6.75a2.25 2.25 0 0 0-2.25 2.25v6.75a2.25 2.25 0 0 0 2.25 2.25Z" stroke-linecap="round" stroke-linejoin="round"></path></g></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Format<wbr/>None</span></a>
<a href="TextBlock.html#FormatTrim" class="tsd-index-link deprecated"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF984D"></use></svg><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF984D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Format<wbr/>Trim</span></a>
<a href="TextBlock.html#None" class="tsd-index-link deprecated"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF984D"></use></svg><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF984D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>None</span></a>
<a href="TextBlock.html#OverflowClip" class="tsd-index-link deprecated"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF984D"></use></svg><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF984D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Overflow<wbr/>Clip</span></a>
<a href="TextBlock.html#OverflowEllipsis" class="tsd-index-link deprecated"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF984D"></use></svg><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF984D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Overflow<wbr/>Ellipsis</span></a>
<a href="TextBlock.html#WrapBreakAll" class="tsd-index-link deprecated"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF984D"></use></svg><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF984D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Wrap<wbr/>Break<wbr/>All</span></a>
<a href="TextBlock.html#WrapDesiredSize" class="tsd-index-link deprecated"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF984D"></use></svg><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF984D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Wrap<wbr/>Desired<wbr/>Size</span></a>
<a href="TextBlock.html#WrapFit" class="tsd-index-link deprecated"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF984D"></use></svg><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF984D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Wrap<wbr/>Fit</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-index-group tsd-is-inherited"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion"><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Inherited Index</h5></summary><div class="tsd-accordion-details"><div class="tsd-index-content"><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="GraphObject.html#actionCancel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.action<wbr/>Cancel</span></a>
<a href="GraphObject.html#actionDown" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.action<wbr/>Down</span></a>
<a href="GraphObject.html#actionMove" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.action<wbr/>Move</span></a>
<a href="GraphObject.html#actionUp" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.action<wbr/>Up</span></a>
<a href="GraphObject.html#actualBounds" class="tsd-index-link"><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF4D4D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.actual<wbr/>Bounds</span></a>
<a href="GraphObject.html#alignment" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.alignment</span></a>
<a href="GraphObject.html#alignmentFocus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.alignment<wbr/>Focus</span></a>
<a href="GraphObject.html#angle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.angle</span></a>
<a href="GraphObject.html#background" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.background</span></a>
<a href="GraphObject.html#click" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.click</span></a>
<a href="GraphObject.html#column" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.column</span></a>
<a href="GraphObject.html#columnSpan" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.column<wbr/>Span</span></a>
<a href="GraphObject.html#contextClick" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.context<wbr/>Click</span></a>
<a href="GraphObject.html#contextMenu" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.context<wbr/>Menu</span></a>
<a href="GraphObject.html#cursor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.cursor</span></a>
<a href="GraphObject.html#desiredSize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.desired<wbr/>Size</span></a>
<a href="GraphObject.html#diagram" class="tsd-index-link"><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF4D4D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.diagram</span></a>
<a href="GraphObject.html#doubleClick" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.double<wbr/>Click</span></a>
<a href="GraphObject.html#enabledChanged" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.enabled<wbr/>Changed</span></a>
<a href="GraphObject.html#fromEndSegmentLength" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.from<wbr/>End<wbr/>Segment<wbr/>Length</span></a>
<a href="GraphObject.html#fromLinkable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.from<wbr/>Linkable</span></a>
<a href="GraphObject.html#fromLinkableDuplicates" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.from<wbr/>Linkable<wbr/>Duplicates</span></a>
<a href="GraphObject.html#fromLinkableSelfNode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.from<wbr/>Linkable<wbr/>Self<wbr/>Node</span></a>
<a href="GraphObject.html#fromMaxLinks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.from<wbr/>Max<wbr/>Links</span></a>
<a href="GraphObject.html#fromShortLength" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.from<wbr/>Short<wbr/>Length</span></a>
<a href="GraphObject.html#fromSpot" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.from<wbr/>Spot</span></a>
<a href="GraphObject.html#height" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.height</span></a>
<a href="GraphObject.html#isActionable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.is<wbr/>Actionable</span></a>
<a href="GraphObject.html#isPanelMain" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.is<wbr/>Panel<wbr/>Main</span></a>
<a href="GraphObject.html#layer" class="tsd-index-link"><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF4D4D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.layer</span></a>
<a href="GraphObject.html#margin" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.margin</span></a>
<a href="GraphObject.html#maxSize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.max<wbr/>Size</span></a>
<a href="GraphObject.html#measuredBounds" class="tsd-index-link"><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF4D4D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.measured<wbr/>Bounds</span></a>
<a href="GraphObject.html#minSize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.min<wbr/>Size</span></a>
<a href="GraphObject.html#mouseDragEnter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.mouse<wbr/>Drag<wbr/>Enter</span></a>
<a href="GraphObject.html#mouseDragLeave" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.mouse<wbr/>Drag<wbr/>Leave</span></a>
<a href="GraphObject.html#mouseDrop" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.mouse<wbr/>Drop</span></a>
<a href="GraphObject.html#mouseEnter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.mouse<wbr/>Enter</span></a>
<a href="GraphObject.html#mouseHold" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.mouse<wbr/>Hold</span></a>
<a href="GraphObject.html#mouseHover" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.mouse<wbr/>Hover</span></a>
<a href="GraphObject.html#mouseLeave" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.mouse<wbr/>Leave</span></a>
<a href="GraphObject.html#mouseOver" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.mouse<wbr/>Over</span></a>
<a href="GraphObject.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.name</span></a>
<a href="GraphObject.html#opacity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.opacity</span></a>
<a href="GraphObject.html#panel" class="tsd-index-link"><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF4D4D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.panel</span></a>
<a href="GraphObject.html#part" class="tsd-index-link"><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF4D4D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.part</span></a>
<a href="GraphObject.html#pickable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.pickable</span></a>
<a href="GraphObject.html#portId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.port<wbr/>Id</span></a>
<a href="GraphObject.html#position" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.position</span></a>
<a href="GraphObject.html#row" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.row</span></a>
<a href="GraphObject.html#rowSpan" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.row<wbr/>Span</span></a>
<a href="GraphObject.html#scale" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.scale</span></a>
<a href="GraphObject.html#segmentFraction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.segment<wbr/>Fraction</span></a>
<a href="GraphObject.html#segmentIndex" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.segment<wbr/>Index</span></a>
<a href="GraphObject.html#segmentOffset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.segment<wbr/>Offset</span></a>
<a href="GraphObject.html#segmentOrientation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.segment<wbr/>Orientation</span></a>
<a href="GraphObject.html#shadowVisible" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.shadow<wbr/>Visible</span></a>
<a href="GraphObject.html#stretch" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.stretch</span></a>
<a href="GraphObject.html#toEndSegmentLength" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.to<wbr/>End<wbr/>Segment<wbr/>Length</span></a>
<a href="GraphObject.html#toLinkable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.to<wbr/>Linkable</span></a>
<a href="GraphObject.html#toLinkableDuplicates" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.to<wbr/>Linkable<wbr/>Duplicates</span></a>
<a href="GraphObject.html#toLinkableSelfNode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.to<wbr/>Linkable<wbr/>Self<wbr/>Node</span></a>
<a href="GraphObject.html#toMaxLinks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.to<wbr/>Max<wbr/>Links</span></a>
<a href="GraphObject.html#toShortLength" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.to<wbr/>Short<wbr/>Length</span></a>
<a href="GraphObject.html#toSpot" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.to<wbr/>Spot</span></a>
<a href="GraphObject.html#toolTip" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.tool<wbr/>Tip</span></a>
<a href="GraphObject.html#visible" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.visible</span></a>
<a href="GraphObject.html#width" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Graph<wbr/>Object.width</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="GraphObject.html#apply" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.apply</span></a>
<a href="GraphObject.html#attach" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.attach</span></a>
<a href="GraphObject.html#bind" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.bind</span></a>
<a href="GraphObject.html#bindModel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.bind<wbr/>Model</span></a>
<a href="GraphObject.html#bindObject" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.bind<wbr/>Object</span></a>
<a href="GraphObject.html#bindTwoWay" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.bind<wbr/>Two<wbr/>Way</span></a>
<a href="GraphObject.html#copy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.copy</span></a>
<a href="GraphObject.html#findBindingPanel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.find<wbr/>Binding<wbr/>Panel</span></a>
<a href="GraphObject.html#getDocumentAngle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.get<wbr/>Document<wbr/>Angle</span></a>
<a href="GraphObject.html#getDocumentBounds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.get<wbr/>Document<wbr/>Bounds</span></a>
<a href="GraphObject.html#getDocumentPoint" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.get<wbr/>Document<wbr/>Point</span></a>
<a href="GraphObject.html#getDocumentScale" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.get<wbr/>Document<wbr/>Scale</span></a>
<a href="GraphObject.html#getLocalPoint" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.get<wbr/>Local<wbr/>Point</span></a>
<a href="GraphObject.html#isContainedBy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.is<wbr/>Contained<wbr/>By</span></a>
<a href="GraphObject.html#isEnabledObject" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.is<wbr/>Enabled<wbr/>Object</span></a>
<a href="GraphObject.html#isVisibleObject" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.is<wbr/>Visible<wbr/>Object</span></a>
<a href="GraphObject.html#set" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.set</span></a>
<a href="GraphObject.html#setProperties" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.set<wbr/>Properties</span></a>
<a href="GraphObject.html#theme" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.theme</span></a>
<a href="GraphObject.html#themeData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.theme<wbr/>Data</span></a>
<a href="GraphObject.html#themeModel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.theme<wbr/>Model</span></a>
<a href="GraphObject.html#themeObject" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.theme<wbr/>Object</span></a>
<a href="GraphObject.html#trigger" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Graph<wbr/>Object.trigger</span></a>
</div></section></div></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_TextBlock" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Text<wbr/>Block</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">init</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a><a href="#constructor.new_TextBlock" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Constructs a <a href="TextBlock.html" class="tsd-kind-class">TextBlock</a>, which by default has no string to show; if it did,
it would draw the text, wrapping if needed, in the default font using a black stroke.</p>
<p>Typical usage:</p>
<pre><code class="language-js"><span class="hl-1">new</span><span class="hl-2"> </span><span class="hl-4">go</span><span class="hl-2">.</span><span class="hl-5">TextBlock</span><span class="hl-2">(</span><span class="hl-6">&quot;Hello World&quot;</span><span class="hl-2">, { </span><span class="hl-4">font:</span><span class="hl-2"> </span><span class="hl-6">&quot;12px sans-serif&quot;</span><span class="hl-2">, </span><span class="hl-4">stroke:</span><span class="hl-2"> </span><span class="hl-6">&quot;gray&quot;</span><span class="hl-2"> })</span>
</code><button>Copy</button></pre>
<p>It is common to data-bind the text:</p>
<pre><code class="language-js"><span class="hl-0">// A Node used as the node template, holding a single TextBlock</span><br/><span class="hl-4">myDiagram</span><span class="hl-2">.</span><span class="hl-4">nodeTemplate</span><span class="hl-2"> =</span><br/><span class="hl-2">  </span><span class="hl-1">new</span><span class="hl-2"> </span><span class="hl-4">go</span><span class="hl-2">.</span><span class="hl-5">Node</span><span class="hl-2">()</span><br/><span class="hl-2">  .</span><span class="hl-5">add</span><span class="hl-2">(</span><br/><span class="hl-2">    </span><span class="hl-1">new</span><span class="hl-2"> </span><span class="hl-4">go</span><span class="hl-2">.</span><span class="hl-5">TextBlock</span><span class="hl-2">({ </span><span class="hl-4">font:</span><span class="hl-2"> </span><span class="hl-6">&quot;12px sans-serif&quot;</span><span class="hl-2">, </span><span class="hl-4">stroke:</span><span class="hl-2"> </span><span class="hl-6">&quot;darkgray&quot;</span><span class="hl-2"> })</span><br/><span class="hl-2">      .</span><span class="hl-5">bind</span><span class="hl-2">(</span><span class="hl-6">&quot;text&quot;</span><span class="hl-2">)</span><br/><span class="hl-2">  );</span><br/><br/><span class="hl-0">// It could be used with model data like this:</span><br/><span class="hl-4">myDiagram</span><span class="hl-2">.</span><span class="hl-4">model</span><span class="hl-2"> = </span><span class="hl-1">new</span><span class="hl-2"> </span><span class="hl-4">go</span><span class="hl-2">.</span><span class="hl-5">GraphLinksModel</span><span class="hl-2">(</span><br/><span class="hl-2">  [</span><br/><span class="hl-2">     { </span><span class="hl-4">key:</span><span class="hl-2"> </span><span class="hl-6">&quot;1&quot;</span><span class="hl-2">, </span><span class="hl-4">text:</span><span class="hl-2"> </span><span class="hl-6">&quot;First TextBlock&quot;</span><span class="hl-2"> },</span><br/><span class="hl-2">     { </span><span class="hl-4">key:</span><span class="hl-2"> </span><span class="hl-6">&quot;2&quot;</span><span class="hl-2">, </span><span class="hl-4">text:</span><span class="hl-2"> </span><span class="hl-6">&quot;Second TextBlock&quot;</span><span class="hl-2"> }</span><br/><span class="hl-2">  ]);</span>
</code><button>Copy</button></pre>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">text</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The textblock&#39;s text.</p>
</div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">init</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><p>Optional initialization properties.</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a></h4></li><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_TextBlock-1" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Text<wbr/>Block</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">init</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a><a href="#constructor.new_TextBlock-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>A newly constructed <a href="TextBlock.html" class="tsd-kind-class">TextBlock</a> has no string to show; if it did,
it would draw the text, wrapping if needed, in the default font using a black stroke.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">init</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><p>Optional initialization properties.</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Accessors</h2><section class="tsd-panel tsd-member"><a id="choices" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>choices</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><a href="#choices" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets the an array of possible choices for a custom <a href="TextEditingTool.html" class="tsd-kind-class">TextEditingTool</a>.
The value must be an array of strings.</p>
<p>The default value is null.
For example usage, see the <a href="../../samples/customTextEditingTool.html">Custom TextEditingTool Sample</a>.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="editable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>editable</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></div><a href="#editable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets whether or not this TextBlock allows in-place editing of the <a href="TextBlock.html#text" class="tsd-kind-accessor">text</a>
string by the user with the help of the <a href="TextEditingTool.html" class="tsd-kind-class">TextEditingTool</a>.
The default is false.</p>
<p>See also <a href="Part.html#textEditable" class="tsd-kind-accessor">Part.textEditable</a>.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="errorFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>error<wbr/>Function</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tool</span><span class="tsd-signature-symbol">: </span><a href="TextEditingTool.html" class="tsd-signature-type tsd-kind-class">TextEditingTool</a>, <span class="tsd-kind-parameter">oldString</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">newString</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><a href="#errorFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets the function to call if a text edit made with the <a href="TextEditingTool.html" class="tsd-kind-class">TextEditingTool</a> is invalid.
The default is null.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="flip" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>flip</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="Flip.html" class="tsd-signature-type tsd-kind-enum">Flip</a></div><a href="#flip" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets how the TextBlock is displayed: Either normally or with a Horizontal or Vertical flip or both.</p>
<p>Possible values are <a href="Flip.html#None" class="tsd-kind-enum-member">Flip.None</a>, <a href="Flip.html#Horizontal" class="tsd-kind-enum-member">Flip.Horizontal</a>, <a href="Flip.html#Vertical" class="tsd-kind-enum-member">Flip.Vertical</a>, or <a href="Flip.html#Both" class="tsd-kind-enum-member">Flip.Both</a>.
The default is <a href="Flip.html#None" class="tsd-kind-enum-member">Flip.None</a>.</p>
</div><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">since</code><p>2.0</p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="font" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>font</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></div><a href="#font" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets the current font settings.
The font property must be a valid CSS string describing a font.
The font string can accept several CSS properties but they must be
in a specific order in order to render correctly across all browsers:</p>
<p><code>&quot;font-style font-variant font-weight font-size font-family&quot;</code></p>
<p>For example, <code>&quot;Italic small-caps bold 32px Georgia, Serif&quot;</code> is a valid font string
using every CSS font property. Not every browser can render every font option.
For more information about CSS font syntax, see <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/font" target="_blank">CSS fonts (mozilla.org)</a>.</p>
<p>If your Node sizes depend on TextBlocks, it is best to ensure any custom fonts you are using are finished loading before you load your Diagram.
This will ensure nodes are sized appropriately for the initial Diagram layout.</p>
<p>The default font is &quot;13px sans-serif&quot;.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="formatting" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>formatting</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="TextFormat.html" class="tsd-signature-type tsd-kind-enum">TextFormat</a></div><a href="#formatting" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets the policy for trimming whitespace on each line of text.</p>
<p>Possible values are <a href="TextFormat.html#Trim" class="tsd-kind-enum-member">TextFormat.Trim</a>, which trims whitespace before and after every line of text,
or <a href="TextFormat.html#None" class="tsd-kind-enum-member">TextFormat.None</a>, which will not trim any whitespace and may be useful for preformatted text.
The default is <a href="TextFormat.html#Trim" class="tsd-kind-enum-member">TextFormat.Trim</a>.</p>
</div><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">since</code><p>2.2</p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="graduatedEnd" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>graduated<wbr/>End</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#graduatedEnd" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets the fractional distance along the main shape of a &quot;Graduated&quot; <a href="Panel.html" class="tsd-kind-class">Panel</a> at which this kind of tick text should end.
The default is 1; the value should range from 0 to 1.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="graduatedFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>graduated<wbr/>Function</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">val</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">tb</span><span class="tsd-signature-symbol">: </span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span></div><a href="#graduatedFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets the function to convert from a value along a &quot;Graduated&quot; <a href="Panel.html" class="tsd-kind-class">Panel</a> to a string.
The default returns a string representing the value rounded to at most 2 decimals.</p>
<p>The function takes a number argument, a value between <a href="Panel.html#graduatedMin" class="tsd-kind-accessor">Panel.graduatedMin</a> and <a href="Panel.html#graduatedMax" class="tsd-kind-accessor">Panel.graduatedMax</a>,
and this TextBlock.
The function will return a string, the text that will appear at the value of the argument.</p>
<p>Note that the second argument is the TextBlock, <em>not</em> a particular label that would be rendered at the given value.
The function, if supplied, must not have any side-effects.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="graduatedSkip" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>graduated<wbr/>Skip</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">val</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">tb</span><span class="tsd-signature-symbol">: </span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></div><a href="#graduatedSkip" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets the function to determine which values along a &quot;Graduated&quot; <a href="Panel.html" class="tsd-kind-class">Panel</a> will be skipped.
The default is null and doesn&#39;t skip any text labels.</p>
<p>The function takes a number argument, a value between <a href="Panel.html#graduatedMin" class="tsd-kind-accessor">Panel.graduatedMin</a> and <a href="Panel.html#graduatedMax" class="tsd-kind-accessor">Panel.graduatedMax</a>,
and this TextBlock.
The function will return a boolean, whether the text label will be skipped at the value of the argument.</p>
<p>Note that the second argument is the TextBlock, <em>not</em> a particular label that would be rendered at the given value.
The function, if supplied, must not have any side-effects.</p>
</div><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">since</code><p>2.0</p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="graduatedStart" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>graduated<wbr/>Start</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#graduatedStart" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets the fractional distance along the main shape of a &quot;Graduated&quot; <a href="Panel.html" class="tsd-kind-class">Panel</a> at which this text should start.
The default is 0; the value should range from 0 to 1.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="interval" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>interval</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#interval" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets how frequently this text should be drawn within a &quot;Graduated&quot; <a href="Panel.html" class="tsd-kind-class">Panel</a>,
in multiples of the <a href="Panel.html#graduatedTickUnit" class="tsd-kind-accessor">Panel.graduatedTickUnit</a>.
The default is 1.  Any new value must be a positive integer.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="isMultiline" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Multiline</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></div><a href="#isMultiline" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets whether or not the text displays multiple lines or embedded newlines.
If this is false, all characters including and after the first newline will be omitted.
The default is true.</p>
</div><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">see</code><p><a href="TextBlock.html#maxLines" class="tsd-kind-accessor">maxLines</a></p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="isOverflowed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadOnly">Readonly</code><span>is<wbr/>Overflowed</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></div><a href="#isOverflowed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets whether the TextBlock text is truncated (overflowed) or not.
This value is set during a TextBlock&#39;s measurement.</p>
<p>As with all read-only properties, using this property as a binding source is unlikely to be useful.</p>
</div><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">since</code><p>2.3</p>
</div><div class="flex items-center"><code class="tsd-tag">see</code><p><a href="TextBlock.html#overflow" class="tsd-kind-accessor">overflow</a></p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="isStrikethrough" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Strikethrough</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></div><a href="#isStrikethrough" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets whether or not the text has a strikethrough line (line-through).
The default is false.</p>
</div><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">see</code><p><a href="TextBlock.html#isUnderline" class="tsd-kind-accessor">isUnderline</a></p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="isUnderline" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Underline</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></div><a href="#isUnderline" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets whether or not the text is underlined.
The default is false.</p>
</div><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">see</code><p><a href="TextBlock.html#isStrikethrough" class="tsd-kind-accessor">isStrikethrough</a></p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="letterSpacing" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>letter<wbr/>Spacing</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></div><a href="#letterSpacing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets additional spacing between letters.
The default is <code>&#39;0px&#39;</code>. The value may be negative.</p>
<p><strong>Warning:</strong> This feature is unsupported in Safari as of 2025.
This may cause some user to experience different spacing and
different TextBlock measurement, depending on their browser.</p>
<p>Just like in CSS letter-spacing, this spacing creates trailing space on the last character.
If this is undesired, consider adding a negative right margin to the TextBlock.</p>
</div><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">see</code><p><a href="TextBlock.html#wordSpacing" class="tsd-kind-accessor">wordSpacing</a></p>
</div><div class="flex items-center"><code class="tsd-tag">since</code><p>3.1</p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="lineCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadOnly">Readonly</code><span>line<wbr/>Count</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#lineCount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>This read-only property returns the computed number of lines in this TextBlock, including lines created
from embedded newlines (<code>\n</code>), <a href="TextBlock.html#wrap" class="tsd-kind-accessor">wrap</a>ping, and <a href="TextBlock.html#maxLines" class="tsd-kind-accessor">maxLines</a>.</p>
<p>This value may be meaningless before the TextBlock is measured.</p>
</div><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">see</code><p><a href="TextBlock.html#lineHeight" class="tsd-kind-accessor">lineHeight</a></p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="lineHeight" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadOnly">Readonly</code><span>line<wbr/>Height</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#lineHeight" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>This read-only property returns the height of a line of text in this TextBlock, not including any <a href="TextBlock.html#spacingAbove" class="tsd-kind-accessor">spacingAbove</a> or <a href="TextBlock.html#spacingBelow" class="tsd-kind-accessor">spacingBelow</a>.</p>
<p>This value may be meaningless before the TextBlock is measured.</p>
</div><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">since</code><p>2.2</p>
</div><div class="flex items-center"><code class="tsd-tag">see</code><p><a href="TextBlock.html#lineCount" class="tsd-kind-accessor">lineCount</a></p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="maxLines" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>max<wbr/>Lines</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#maxLines" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets the maximum number of lines that this TextBlock can display.
Value must be a greater than zero whole number or <code>Infinity</code>.
The default is <code>Infinity</code>.</p>
<p>Modifying this value may modify the computed height of the TextBlock.
If maxLines is set, the value of <a href="TextBlock.html#lineCount" class="tsd-kind-accessor">lineCount</a> will never be larger than maxLines.</p>
</div><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">see</code><p><a href="TextBlock.html#isMultiline" class="tsd-kind-accessor">isMultiline</a></p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="naturalBounds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadOnly">Readonly</code><span>natural<wbr/>Bounds</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="Rect.html" class="tsd-signature-type tsd-kind-class">Rect</a></div><a href="#naturalBounds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>This read-only property returns the natural bounds of this TextBlock in local coordinates,
as determined by its <a href="TextBlock.html#font" class="tsd-kind-accessor">font</a> and <a href="TextBlock.html#text" class="tsd-kind-accessor">text</a> string, and optionally its desiredSize.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="overflow" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>overflow</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="TextOverflow.html" class="tsd-signature-type tsd-kind-enum">TextOverflow</a></div><a href="#overflow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets how text that is too long to display should be handled.</p>
<p>Possible values are <a href="TextOverflow.html#Clip" class="tsd-kind-enum-member">TextOverflow.Clip</a> and <a href="TextOverflow.html#Ellipsis" class="tsd-kind-enum-member">TextOverflow.Ellipsis</a>.
For Ellipsis to work, you must constrain the available size of the TextBlock in some way,
such as setting <a href="TextBlock.html#wrap" class="tsd-kind-accessor">wrap</a> to <a href="Wrap.html#None" class="tsd-kind-enum-member">Wrap.None</a>,
or limiting the number of lines with <a href="TextBlock.html#maxLines" class="tsd-kind-accessor">maxLines</a> or a height constraint.</p>
<p>With Ellipsis, setting the <a href="TextBlock.html#wrap" class="tsd-kind-accessor">wrap</a> value to <a href="Wrap.html#BreakAll" class="tsd-kind-enum-member">Wrap.BreakAll</a> will allow ellipses to break partial words.</p>
<p>The default value is <a href="TextOverflow.html#Clip" class="tsd-kind-enum-member">TextOverflow.Clip</a>.</p>
</div><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">see</code><p><a href="TextBlock.html#wrap" class="tsd-kind-accessor">wrap</a></p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="spacingAbove" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>spacing<wbr/>Above</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#spacingAbove" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets additional spacing above each line of text.
The default is zero. The value may be negative.</p>
<p>This can be useful when you need to adjust the font spacing on
custom fonts or monospace fonts to suit your needs.</p>
</div><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">since</code><p>2.2</p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="spacingBelow" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>spacing<wbr/>Below</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#spacingBelow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets additional spacing below each line of text.
The default is zero. The value may be negative.</p>
<p>This can be useful when you need to adjust the font spacing on
custom fonts or monospace fonts to suit your needs.</p>
</div><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">since</code><p>2.2</p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="stroke" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stroke</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="BrushLike.html" class="tsd-signature-type tsd-kind-type-alias">BrushLike</a></div><a href="#stroke" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets the <a href="Brush.html" class="tsd-kind-class">Brush</a> or string that describes the stroke (color) of the text that is drawn.</p>
<p>The default value is <code>&quot;black&quot;</code>.
Any valid CSS string can specify a solid color, and the <a href="Brush.html" class="tsd-kind-class">Brush</a>
class can be used to specify a gradient or pattern.
More information about the syntax of CSS color strings is available at:
<a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color" target="_blank">CSS colors (mozilla.org)</a>.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="text" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>text</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></div><a href="#text" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets the TextBlock&#39;s text string. The default is an empty string.
The text of a TextBlock, along with the values of <a href="TextBlock.html#font" class="tsd-kind-accessor">font</a>, <a href="TextBlock.html#wrap" class="tsd-kind-accessor">wrap</a>,
<a href="TextBlock.html#isMultiline" class="tsd-kind-accessor">isMultiline</a> and sizing restrictions are what naturally determine
the size of the TextBlock.</p>
<p>The text in textblocks can include manual line-breaks by using the character escape, <code>\n</code>.</p>
<p>Leading and trailing whitespace is eliminated in each line of TextBlock text.</p>
<p>If <a href="TextBlock.html#editable" class="tsd-kind-accessor">editable</a> is set to true, users can edit textblocks with the <a href="TextEditingTool.html" class="tsd-kind-class">TextEditingTool</a>.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="textAlign" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>text<wbr/>Align</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;right&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;left&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;center&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;start&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;end&quot;</span></div><a href="#textAlign" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets the alignment location in the TextBlock&#39;s given space.
The only possible values are <code>&quot;start&quot;</code>, <code>&quot;end&quot;</code>, <code>&quot;left&quot;</code>, <code>&quot;right&quot;</code>, and <code>&quot;center&quot;</code>.
Any other value is invalid.</p>
<p>This property is most pertinent when the TextBlock has multiple lines of text,
or when the TextBlock is given a size that differs from the text&#39;s natural size (such as with desiredSize).</p>
<p>In left-to-right writing systems, <code>&quot;start&quot;</code> and <code>&quot;left&quot;</code> are synonymous, as are <code>&quot;end&quot;</code> and <code>&quot;right&quot;</code>.</p>
<p>The default is <code>&quot;start&quot;</code>.</p>
</div><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">see</code><p><a href="TextBlock.html#verticalAlignment" class="tsd-kind-accessor">verticalAlignment</a></p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="textEdited" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>text<wbr/>Edited</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">thisTextBlock</span><span class="tsd-signature-symbol">: </span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a>, <span class="tsd-kind-parameter">oldString</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">newString</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><a href="#textEdited" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets the function that is called after the TextBlock&#39;s text has been edited by the <a href="TextEditingTool.html" class="tsd-kind-class">TextEditingTool</a>.</p>
<ul>
<li>The first argument is a reference to this TextBlock.</li>
<li>The second argument is the previous text, before editing.</li>
<li>The third argument is the current text, which is also TextBlock.text.</li>
</ul>
<pre><code class="language-js"><span class="hl-1">function</span><span class="hl-2">(</span><span class="hl-4">textBlock</span><span class="hl-2">, </span><span class="hl-4">previousText</span><span class="hl-2">, </span><span class="hl-4">currentText</span><span class="hl-2">)</span>
</code><button>Copy</button></pre>
<p>The default value is null -- no function is called.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="textEditor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>text<wbr/>Editor</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="HTMLInfo.html" class="tsd-signature-type tsd-kind-class">HTMLInfo</a></div><a href="#textEditor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets the HTMLInfo that this TextBlock uses as its text editor in the TextEditingTool.
If null, the TextBlock will use the default text editor of the <a href="TextEditingTool.html" class="tsd-kind-class">TextEditingTool</a>.
The default is null.
The value should be set to an instance of <a href="HTMLInfo.html" class="tsd-kind-class">HTMLInfo</a>.
Setting this property might not affect any ongoing text editing operation.</p>
<p>For example usage, see the <a href="../../samples/customTextEditingTool.html">Custom TextEditingTool Sample</a>.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="textValidation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>text<wbr/>Validation</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">thisTextBlock</span><span class="tsd-signature-symbol">: </span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a>, <span class="tsd-kind-parameter">oldString</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">newString</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></div><a href="#textValidation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets the predicate that determines whether or not a user-edited string of text is valid.
If this is non-null, the predicate is called in addition to any <a href="TextEditingTool.html#textValidation" class="tsd-kind-accessor">TextEditingTool.textValidation</a> predicate.
See <a href="TextEditingTool.html#isValidText" class="tsd-kind-method">TextEditingTool.isValidText</a> for more details.</p>
<pre><code class="language-js"><span class="hl-1">function</span><span class="hl-2">(</span><span class="hl-4">textBlock</span><span class="hl-2">, </span><span class="hl-4">oldString</span><span class="hl-2">, </span><span class="hl-4">newString</span><span class="hl-2">)</span>
</code><button>Copy</button></pre>
<p>The default predicate is null, which is equivalent to simply returning true.</p>
<p>The function, if supplied, must not have any side-effects, and must return true or false.</p>
</div><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">see</code><p><a href="TextEditingTool.html#textValidation" class="tsd-kind-accessor">TextEditingTool.textValidation</a></p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="verticalAlignment" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>vertical<wbr/>Alignment</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="Spot.html" class="tsd-signature-type tsd-kind-class">Spot</a></div><a href="#verticalAlignment" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets the vertical alignment <a href="Spot.html" class="tsd-kind-class">Spot</a> of this TextBlock, used when
the TextBlock has more available vertical space than it needs to draw all lines.</p>
<p>The default value is <a href="Spot.html#Top" class="tsd-kind-property">Spot.Top</a>, which aligns the TextBlock to the top of its available space.</p>
<p>The <a href="TextBlock.html#textAlign" class="tsd-kind-accessor">textAlign</a> is often used along with this property to specify
where the should be positioned in its available space.</p>
<p>This does not affect TextBlock coordinates or bounds, it only affects where text is drawn within the given area.</p>
</div><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">see</code><p><a href="TextBlock.html#textAlign" class="tsd-kind-accessor">textAlign</a></p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="wordSpacing" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>word<wbr/>Spacing</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></div><a href="#wordSpacing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets additional spacing between words.
The default is <code>&#39;0px&#39;</code>. The value may be negative.</p>
<p><strong>Warning:</strong> This feature is unsupported in Safari as of 2025.
This may cause some user to experience different spacing and
different TextBlock measurement, depending on their browser.</p>
</div><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">see</code><p><a href="TextBlock.html#letterSpacing" class="tsd-kind-accessor">letterSpacing</a></p>
</div><div class="flex items-center"><code class="tsd-tag">since</code><p>3.1</p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="wrap" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wrap</span><div class="membertype"><span class="tsd-signature-symbol">: </span><a href="Wrap.html" class="tsd-signature-type tsd-kind-enum">Wrap</a></div><a href="#wrap" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets or sets whether the text should be wrapped if it is too long to fit on one line.</p>
<p>Possible values are <a href="Wrap.html#DesiredSize" class="tsd-kind-enum-member">Wrap.DesiredSize</a>, <a href="Wrap.html#Fit" class="tsd-kind-enum-member">Wrap.Fit</a>, <a href="Wrap.html#BreakAll" class="tsd-kind-enum-member">Wrap.BreakAll</a>,
and <a href="Wrap.html#None" class="tsd-kind-enum-member">Wrap.None</a>.</p>
<p>The default value is <a href="Wrap.html#DesiredSize" class="tsd-kind-enum-member">Wrap.DesiredSize</a>.</p>
</div><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">see</code><p><a href="TextBlock.html#overflow" class="tsd-kind-accessor">overflow</a></p>
</div></div></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getBaseline" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Baseline</span><a href="#getBaseline" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getBaseline.getBaseline-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Baseline</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">textBlock</span><span class="tsd-signature-symbol">: </span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a>, <span class="tsd-kind-parameter">textHeight</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><a href="#getBaseline.getBaseline-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the function that, given the TextBlock and numerical text height, computes the position to draw the baseline of a line of text in all TextBlocks.
By default this is null and default behavior returns <code>(textHeight * 0.75)</code>.</p>
<p>This computation affects drawing only, and does not change TextBlock measurement calculations.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">textBlock</span><span class="tsd-signature-symbol">: </span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a>, <span class="tsd-kind-parameter">textHeight</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="getBaseline.getBaseline-1.__type-10.__type-11"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">textBlock</span><span class="tsd-signature-symbol">: </span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a>, <span class="tsd-kind-parameter">textHeight</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">textBlock</span>: <a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a></h5></li><li><h5><span class="tsd-kind-parameter">textHeight</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></li></ul><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">since</code><p>2.0</p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getUnderline" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Underline</span><a href="#getUnderline" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getUnderline.getUnderline-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Underline</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">textBlock</span><span class="tsd-signature-symbol">: </span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a>, <span class="tsd-kind-parameter">textHeight</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><a href="#getUnderline.getUnderline-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the function that, given the TextBlock and numerical text height, computes the position to draw the underline of a line of text in all TextBlocks.
By default this is null and default behavior returns <code>(textHeight * 0.75)</code>.</p>
<p>This computation affects drawing only, and does not change TextBlock measurement calculations.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">textBlock</span><span class="tsd-signature-symbol">: </span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a>, <span class="tsd-kind-parameter">textHeight</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="getUnderline.getUnderline-1.__type-12.__type-13"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">textBlock</span><span class="tsd-signature-symbol">: </span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a>, <span class="tsd-kind-parameter">textHeight</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">textBlock</span>: <a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a></h5></li><li><h5><span class="tsd-kind-parameter">textHeight</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></li></ul><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">since</code><p>2.0</p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="isValidFont" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>is<wbr/>Valid<wbr/>Font</span><a href="#isValidFont" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isValidFont.isValidFont-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Valid<wbr/>Font</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">font</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isValidFont.isValidFont-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>This static predicate returns true if the given font is a valid font.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">font</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">since</code><p>3.0</p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setBaseline" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>set<wbr/>Baseline</span><a href="#setBaseline" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setBaseline.setBaseline-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Baseline</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">textBlock</span><span class="tsd-signature-symbol">: </span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a>, <span class="tsd-kind-parameter">textHeight</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setBaseline.setBaseline-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the function that, given the TextBlock and numerical text height, computes the position to draw the baseline of a line of text in all TextBlocks.</p>
<p>This computation affects drawing only, and does not change TextBlock measurement calculations.
It is expected this method will be called before or during initialization of any Diagram.
Diagrams will not redraw when this method has been called,
and you should call <code>Diagram.redraw()</code> if you are calling this method outside of your initialization.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">textBlock</span><span class="tsd-signature-symbol">: </span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a>, <span class="tsd-kind-parameter">textHeight</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">textBlock</span><span class="tsd-signature-symbol">: </span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a>, <span class="tsd-kind-parameter">textHeight</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">textBlock</span>: <a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a></h5></li><li><h5><span class="tsd-kind-parameter">textHeight</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">since</code><p>2.0</p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setUnderline" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>set<wbr/>Underline</span><a href="#setUnderline" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setUnderline.setUnderline-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Underline</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">textBlock</span><span class="tsd-signature-symbol">: </span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a>, <span class="tsd-kind-parameter">textHeight</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setUnderline.setUnderline-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the function that, given the TextBlock and numerical text height, computes the position to draw the underline of a line of text in all TextBlocks.</p>
<p>This computation affects drawing only, and does not change TextBlock measurement calculations.
It is expected this method will be called before or during initialization of any Diagram.
Diagrams will not redraw when this method has been called,
and you should call <code>Diagram.redraw()</code> if you are calling this method outside of your initialization.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">textBlock</span><span class="tsd-signature-symbol">: </span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a>, <span class="tsd-kind-parameter">textHeight</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">textBlock</span><span class="tsd-signature-symbol">: </span><a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a>, <span class="tsd-kind-parameter">textHeight</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">textBlock</span>: <a href="TextBlock.html" class="tsd-signature-type tsd-kind-class">TextBlock</a></h5></li><li><h5><span class="tsd-kind-parameter">textHeight</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">since</code><p>2.0</p>
</div></div></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="FormatNone" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">Format<wbr/>None</span><a href="#FormatNone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">deprecated</code><p>See <a href="TextFormat.html#None" class="tsd-kind-enum-member">TextFormat.None</a>.</p>
</div></div></section><section class="tsd-panel tsd-member"><a id="FormatTrim" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">Format<wbr/>Trim</span><a href="#FormatTrim" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">deprecated</code><p>See <a href="TextFormat.html#Trim" class="tsd-kind-enum-member">TextFormat.Trim</a>.</p>
</div></div></section><section class="tsd-panel tsd-member"><a id="None" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">None</span><a href="#None" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">deprecated</code><p>See <a href="Wrap.html#None" class="tsd-kind-enum-member">Wrap.None</a>.</p>
</div></div></section><section class="tsd-panel tsd-member"><a id="OverflowClip" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">Overflow<wbr/>Clip</span><a href="#OverflowClip" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">deprecated</code><p>See <a href="TextOverflow.html#Clip" class="tsd-kind-enum-member">TextOverflow.Clip</a>.</p>
</div></div></section><section class="tsd-panel tsd-member"><a id="OverflowEllipsis" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">Overflow<wbr/>Ellipsis</span><a href="#OverflowEllipsis" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">deprecated</code><p>See <a href="TextOverflow.html#Ellipsis" class="tsd-kind-enum-member">TextOverflow.Ellipsis</a>.</p>
</div></div></section><section class="tsd-panel tsd-member"><a id="WrapBreakAll" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">Wrap<wbr/>Break<wbr/>All</span><a href="#WrapBreakAll" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">deprecated</code><p>See <a href="Wrap.html#BreakAll" class="tsd-kind-enum-member">Wrap.BreakAll</a>.</p>
</div></div></section><section class="tsd-panel tsd-member"><a id="WrapDesiredSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">Wrap<wbr/>Desired<wbr/>Size</span><a href="#WrapDesiredSize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">deprecated</code><p>See <a href="Wrap.html#DesiredSize" class="tsd-kind-enum-member">Wrap.DesiredSize</a>.</p>
</div></div></section><section class="tsd-panel tsd-member"><a id="WrapFit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="deprecated">Wrap<wbr/>Fit</span><a href="#WrapFit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">deprecated</code><p>See <a href="Wrap.html#Fit" class="tsd-kind-enum-member">Wrap.Fit</a>.</p>
</div></div></section></section></div><div class="col-sidebar"><div class="page-menu"><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><ul><li><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></li><li><a href="#choices"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>choices</span></a></li><li><a href="#editable"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>editable</span></a></li><li><a href="#errorFunction"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>error<wbr/>Function</span></a></li><li><a href="#flip"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>flip</span></a></li><li><a href="#font"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>font</span></a></li><li><a href="#formatting"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>formatting</span></a></li><li><a href="#graduatedEnd"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>graduated<wbr/>End</span></a></li><li><a href="#graduatedFunction"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>graduated<wbr/>Function</span></a></li><li><a href="#graduatedSkip"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>graduated<wbr/>Skip</span></a></li><li><a href="#graduatedStart"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>graduated<wbr/>Start</span></a></li><li><a href="#interval"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>interval</span></a></li><li><a href="#isMultiline"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Multiline</span></a></li><li><a href="#isOverflowed"><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF4D4D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Overflowed</span></a></li><li><a href="#isStrikethrough"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Strikethrough</span></a></li><li><a href="#isUnderline"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>is<wbr/>Underline</span></a></li><li><a href="#letterSpacing"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>letter<wbr/>Spacing</span></a></li><li><a href="#lineCount"><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF4D4D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>line<wbr/>Count</span></a></li><li><a href="#lineHeight"><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF4D4D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>line<wbr/>Height</span></a></li><li><a href="#maxLines"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>max<wbr/>Lines</span></a></li><li><a href="#naturalBounds"><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF4D4D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>natural<wbr/>Bounds</span></a></li><li><a href="#overflow"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>overflow</span></a></li><li><a href="#spacingAbove"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>spacing<wbr/>Above</span></a></li><li><a href="#spacingBelow"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>spacing<wbr/>Below</span></a></li><li><a href="#stroke"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>stroke</span></a></li><li><a href="#text"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>text</span></a></li><li><a href="#textAlign"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>text<wbr/>Align</span></a></li><li><a href="#textEdited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>text<wbr/>Edited</span></a></li><li><a href="#textEditor"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>text<wbr/>Editor</span></a></li><li><a href="#textValidation"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>text<wbr/>Validation</span></a></li><li><a href="#verticalAlignment"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>vertical<wbr/>Alignment</span></a></li><li><a href="#wordSpacing"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>word<wbr/>Spacing</span></a></li><li><a href="#wrap"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>wrap</span></a></li><li><a href="#getBaseline"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF4DB8"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Baseline</span></a></li><li><a href="#getUnderline"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF4DB8"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Underline</span></a></li><li><a href="#isValidFont"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF4DB8"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Valid<wbr/>Font</span></a></li><li><a href="#setBaseline"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF4DB8"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Baseline</span></a></li><li><a href="#setUnderline"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF4DB8"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Underline</span></a></li><li><a href="#FormatNone" class="deprecated"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF984D"></use></svg><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF984D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Format<wbr/>None</span></a></li><li><a href="#FormatTrim" class="deprecated"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF984D"></use></svg><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF984D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Format<wbr/>Trim</span></a></li><li><a href="#None" class="deprecated"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF984D"></use></svg><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF984D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>None</span></a></li><li><a href="#OverflowClip" class="deprecated"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF984D"></use></svg><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF984D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Overflow<wbr/>Clip</span></a></li><li><a href="#OverflowEllipsis" class="deprecated"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF984D"></use></svg><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF984D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Overflow<wbr/>Ellipsis</span></a></li><li><a href="#WrapBreakAll" class="deprecated"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF984D"></use></svg><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF984D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Wrap<wbr/>Break<wbr/>All</span></a></li><li><a href="#WrapDesiredSize" class="deprecated"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF984D"></use></svg><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF984D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Wrap<wbr/>Desired<wbr/>Size</span></a></li><li><a href="#WrapFit" class="deprecated"><svg class="static tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-S,#FF984D"></use></svg><svg class="readonly tsd-subicon" viewBox="0 0 28 28"><use href="#subicon-R,#FF984D"></use></svg><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Wrap<wbr/>Fit</span></a></li></ul></div></details><div class="tsd-navigation settings"><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">System</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>GoJS API</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><div class="tsd w-full max-w-screen-xl mx-auto px-2"><div class="bottom-copyright">Copyright © 1998-2025 by Northwoods Software Corporation.</div></div><div class="overlay"></div><script async src="https://www.googletagmanager.com/gtag/js?id=G-S5QK8VSK84"></script><script>window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-S5QK8VSK84');
var getOutboundLink = function(url, label) {
  gtag('event', 'click', {
  'event_category': 'outbound',
  'event_label': label,
  'transport_type': 'beacon'
  });
}

document.getElementById("contactBtn").addEventListener("click", function() {
  getOutboundLink('https://nwoods.com/contact.html', 'contact');
});
document.getElementById("buyBtn").addEventListener("click", function() {
  getOutboundLink('https://nwoods.com/sales/index.html', 'buy');
});</script></body></html>