create-gojs-kit
Version:
A CLI for downloading GoJS samples, extensions, and docs
130 lines (128 loc) • 26.9 kB
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>HTMLInfo | 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="HTMLInfo.html">HTMLInfo</a></li></ul><h1 class="flex items-center">Class HTMLInfo</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-comment"><div class="tsd-comment tsd-typography"><p>HTMLInfo is used to show and hide custom HTML page elements, such as a context menu, tooltip, or text editor made of HTML.</p>
<p>Properties that can be set to an HTMLInfo include:</p>
<ul>
<li><a href="TextEditingTool.html#defaultTextEditor" class="tsd-kind-accessor">TextEditingTool.defaultTextEditor</a></li>
<li><a href="TextBlock.html#textEditor" class="tsd-kind-accessor">TextBlock.textEditor</a></li>
<li><a href="GraphObject.html#contextMenu" class="tsd-kind-accessor">GraphObject.contextMenu</a></li>
<li><a href="Diagram.html#contextMenu" class="tsd-kind-accessor">Diagram.contextMenu</a></li>
<li><a href="GraphObject.html#toolTip" class="tsd-kind-accessor">GraphObject.toolTip</a></li>
<li><a href="Diagram.html#toolTip" class="tsd-kind-accessor">Diagram.toolTip</a></li>
</ul>
<p>When a context menu is set to an instance of HTMLInfo,
<a href="ContextMenuTool.html#showContextMenu" class="tsd-kind-method">ContextMenuTool.showContextMenu</a> and <a href="ContextMenuTool.html#hideContextMenu" class="tsd-kind-method">ContextMenuTool.hideContextMenu</a>
call <a href="HTMLInfo.html#show" class="tsd-kind-accessor">show</a> and <a href="HTMLInfo.html#hide" class="tsd-kind-accessor">hide</a> respectively. You may define <a href="HTMLInfo.html#mainElement" class="tsd-kind-accessor">mainElement</a>
instead of <a href="HTMLInfo.html#hide" class="tsd-kind-accessor">hide</a> in order to automatically use a default hide method.</p>
<p>When a tooltip is set to an instance of HTMLInfo,
<a href="ToolManager.html#showToolTip" class="tsd-kind-method">ToolManager.showToolTip</a> and <a href="ToolManager.html#hideToolTip" class="tsd-kind-method">ToolManager.hideToolTip</a>
call <a href="HTMLInfo.html#show" class="tsd-kind-accessor">show</a> and <a href="HTMLInfo.html#hide" class="tsd-kind-accessor">hide</a> respectively.</p>
<p>When a text editor is set to an instance of HTMLInfo,
<a href="TextEditingTool.html#doActivate" class="tsd-kind-method">TextEditingTool.doActivate</a> calls <a href="HTMLInfo.html#show" class="tsd-kind-accessor">show</a> and <a href="TextEditingTool.html#doDeactivate" class="tsd-kind-method">TextEditingTool.doDeactivate</a> calls <a href="HTMLInfo.html#hide" class="tsd-kind-accessor">hide</a>.</p>
<p>For HTMLInfo to work, you must define <a href="HTMLInfo.html#show" class="tsd-kind-accessor">show</a>
and either <a href="HTMLInfo.html#hide" class="tsd-kind-accessor">hide</a> or <a href="HTMLInfo.html#mainElement" class="tsd-kind-accessor">mainElement</a>.
Typical usage will also stop the <a href="ContextMenuTool.html" class="tsd-kind-class">ContextMenuTool</a> once the desired context action occurs,
typically by calling <code>diagram.currentTool.stopTool();</code>.</p>
<p>Example usage of HTMLInfo can be found in the
<a href="../../samples/customContextMenu.html">Custom Context Menu</a> and
<a href="../../samples/htmlLightBoxContextMenu.html">HTML LightBox Context Menu</a> samples, the
<a href="../../samples/customTextEditingTool.html">Custom TextEditingTool sample</a>, and the
<a href="../../extensions/TextEditor.html">Text Editor implementation extension</a>.</p>
<p>Here is the outline for typical usage of HTMLInfo as a context menu:</p>
<pre><code class="language-js"><span class="hl-0">// Assign an HTMLInfo to the Diagram:</span><br/><span class="hl-4">myDiagram</span><span class="hl-2">.</span><span class="hl-4">contextMenu</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">HTMLInfo</span><span class="hl-2">({</span><br/><span class="hl-2"> </span><span class="hl-4">show:</span><span class="hl-2"> </span><span class="hl-4">showContextMenu</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-4">hide:</span><span class="hl-2"> </span><span class="hl-4">hideContextMenu</span><br/><span class="hl-2">});</span><br/><br/><span class="hl-1">function</span><span class="hl-2"> </span><span class="hl-5">showContextMenu</span><span class="hl-2">(</span><span class="hl-4">obj</span><span class="hl-2">, </span><span class="hl-4">diagram</span><span class="hl-2">, </span><span class="hl-4">tool</span><span class="hl-2">) {</span><br/><span class="hl-2"> </span><span class="hl-0">// Show the context menu HTML element:</span><br/><span class="hl-2"> </span><span class="hl-4">SomeDOMElement</span><span class="hl-2">.</span><span class="hl-4">style</span><span class="hl-2">.</span><span class="hl-4">display</span><span class="hl-2"> = </span><span class="hl-6">"block"</span><span class="hl-2">;</span><br/><br/><span class="hl-2"> </span><span class="hl-0">// Also show relevant buttons given the current state</span><br/><span class="hl-2"> </span><span class="hl-0">// and the GraphObject obj; if null, the context menu is for the whole Diagram</span><br/><span class="hl-2">}</span><br/><br/><span class="hl-1">function</span><span class="hl-2"> </span><span class="hl-5">hideContextMenu</span><span class="hl-2">() {</span><br/><span class="hl-2"> </span><span class="hl-4">SomeDOMElement</span><span class="hl-2">.</span><span class="hl-4">style</span><span class="hl-2">.</span><span class="hl-4">display</span><span class="hl-2"> = </span><span class="hl-6">"none"</span><span class="hl-2">;</span><br/><span class="hl-2">}</span><br/><br/><span class="hl-1">function</span><span class="hl-2"> </span><span class="hl-5">buttonClick</span><span class="hl-2">() {</span><br/><span class="hl-2"> </span><span class="hl-0">// do some action when a context menu button is clicked</span><br/><br/><span class="hl-2"> </span><span class="hl-0">// then:</span><br/><span class="hl-2"> </span><span class="hl-4">myDiagram</span><span class="hl-2">.</span><span class="hl-4">currentTool</span><span class="hl-2">.</span><span class="hl-5">stopTool</span><span class="hl-2">();</span><br/><span class="hl-2">}</span>
</code><button>Copy</button></pre>
<p>By default, <a href="TextEditingTool.html#defaultTextEditor" class="tsd-kind-accessor">TextEditingTool.defaultTextEditor</a> is an instance of HTMLInfo.
You can see its default implementation details <a href="../../extensions/TextEditor.html">here</a>.</p>
</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="HTMLInfo.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="HTMLInfo.html#hide" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>hide</span></a>
<a href="HTMLInfo.html#mainElement" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>main<wbr/>Element</span></a>
<a href="HTMLInfo.html#show" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>show</span></a>
<a href="HTMLInfo.html#valueFunction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>value<wbr/>Function</span></a>
</div></section></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_HTMLInfo" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new HTMLInfo</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"><</span><a href="HTMLInfo.html" class="tsd-signature-type tsd-kind-class">HTMLInfo</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="HTMLInfo.html" class="tsd-signature-type tsd-kind-class">HTMLInfo</a><a href="#constructor.new_HTMLInfo" 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 HTMLInfo can be assigned as a value of <a href="TextEditingTool.html#defaultTextEditor" class="tsd-kind-accessor">TextEditingTool.defaultTextEditor</a>, <a href="TextBlock.html#textEditor" class="tsd-kind-accessor">TextBlock.textEditor</a>
<a href="GraphObject.html#contextMenu" class="tsd-kind-accessor">GraphObject.contextMenu</a>, <a href="Diagram.html#contextMenu" class="tsd-kind-accessor">Diagram.contextMenu</a>, <a href="GraphObject.html#toolTip" class="tsd-kind-accessor">GraphObject.toolTip</a>, or <a href="Diagram.html#toolTip" class="tsd-kind-accessor">Diagram.toolTip</a>.</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"><</span><a href="HTMLInfo.html" class="tsd-signature-type tsd-kind-class">HTMLInfo</a><span class="tsd-signature-symbol">></span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="HTMLInfo.html" class="tsd-signature-type tsd-kind-class">HTMLInfo</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="hide" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>hide</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">a</span><span class="tsd-signature-symbol">: </span><a href="Diagram.html" class="tsd-signature-type tsd-kind-class">Diagram</a>, <span class="tsd-kind-parameter">b</span><span class="tsd-signature-symbol">: </span><a href="Tool.html" class="tsd-signature-type tsd-kind-class">Tool</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><a href="#hide" 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 when an HTMLInfo is to be hidden.
The function should "hide" the HTMLInfo, either by removing any traces of it or otherwise
returning the page state to one where the HTMLInfo content is no longer considered active.</p>
<p>Setting this is not strictly necessary, if no action is to be taken when hiding the HTMLInfo.</p>
<p>If this is called by:</p>
<ul>
<li><a href="ContextMenuTool.html#hideContextMenu" class="tsd-kind-method">ContextMenuTool.hideContextMenu</a>, the second argument is the <a href="ContextMenuTool.html" class="tsd-kind-class">ContextMenuTool</a>.</li>
<li><a href="ToolManager.html#hideToolTip" class="tsd-kind-method">ToolManager.hideToolTip</a>, the second argument is the <a href="ToolManager.html" class="tsd-kind-class">ToolManager</a>.</li>
<li><a href="TextEditingTool.html#doDeactivate" class="tsd-kind-method">TextEditingTool.doDeactivate</a>, the second argument is the <a href="TextEditingTool.html" class="tsd-kind-class">TextEditingTool</a>.</li>
</ul>
</div><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">see</code><p><a href="HTMLInfo.html#mainElement" class="tsd-kind-accessor">mainElement</a></p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="mainElement" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>main<wbr/>Element</span><div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span></div><a href="#mainElement" 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 primary HTML Element that represents this HTMLInfo.
In a context menu, this would be the outermost HTML element, the one which typically
shows and hides. If this is set and <a href="HTMLInfo.html#hide" class="tsd-kind-accessor">hide</a> is not, HTMLInfo will automatically execute:</p>
<pre><code class="language-js"><span class="hl-2"> </span><span class="hl-4">info</span><span class="hl-2">.</span><span class="hl-4">mainElement</span><span class="hl-2">.</span><span class="hl-4">style</span><span class="hl-2">.</span><span class="hl-4">display</span><span class="hl-2"> = </span><span class="hl-6">"none"</span><span class="hl-2">;</span>
</code><button>Copy</button></pre>
<p>when <a href="HTMLInfo.html#hide" class="tsd-kind-accessor">hide</a> would typically be called.</p>
<p>This is set only for convenience; the default value for this property is null.</p>
</div><div class="tsd-comment-tags tsd-typography"><div class="flex items-center"><code class="tsd-tag">see</code><p><a href="HTMLInfo.html#hide" class="tsd-kind-accessor">hide</a></p>
</div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="show" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>show</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">a</span><span class="tsd-signature-symbol">: </span><a href="GraphObject.html" class="tsd-signature-type tsd-kind-class">GraphObject</a>, <span class="tsd-kind-parameter">b</span><span class="tsd-signature-symbol">: </span><a href="Diagram.html" class="tsd-signature-type tsd-kind-class">Diagram</a>, <span class="tsd-kind-parameter">c</span><span class="tsd-signature-symbol">: </span><a href="Tool.html" class="tsd-signature-type tsd-kind-class">Tool</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><a href="#show" 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 when an HTMLInfo is to be shown,
such as when used as the <a href="GraphObject.html#contextMenu" class="tsd-kind-accessor">GraphObject.contextMenu</a> or <a href="Diagram.html#toolTip" class="tsd-kind-accessor">Diagram.toolTip</a> or <a href="TextBlock.html#textEditor" class="tsd-kind-accessor">TextBlock.textEditor</a>.</p>
<p>If this is called by:</p>
<ul>
<li><a href="ContextMenuTool.html#showContextMenu" class="tsd-kind-method">ContextMenuTool.showContextMenu</a>, the first argument is the <a href="GraphObject.html" class="tsd-kind-class">GraphObject</a> for which the context menu is being shown, or null for the diagram background.</li>
<li><a href="ToolManager.html#showToolTip" class="tsd-kind-method">ToolManager.showToolTip</a>, the first argument is the <a href="GraphObject.html" class="tsd-kind-class">GraphObject</a> for which the tooltip is being shown, or null for the diagram background.</li>
<li><a href="TextEditingTool.html#doActivate" class="tsd-kind-method">TextEditingTool.doActivate</a>, the first argument is the <a href="TextBlock.html" class="tsd-kind-class">TextBlock</a> for which the text editor is being shown.</li>
</ul>
<p>If you need access to any bound data for the first argument, if it is non-null, you can get it via:
<code>obj.part.data</code>
and then you can look at any of the properties you have put on that data.</p>
<p>When used as a context menu, typically shown elements, such as buttons, should call
<code>diagram.currentTool.stopTool();</code> when their action is completed.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="valueFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value<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-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><a href="#valueFunction" 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 a function that returns the primary value associated with this HTMLInfo,
such as the string value of a text editor, which would be solicited by the <a href="TextEditingTool.html" class="tsd-kind-class">TextEditingTool</a>.</p>
<p>This typically returns a string.</p>
</div></li></ul></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="#hide"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>hide</span></a></li><li><a href="#mainElement"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>main<wbr/>Element</span></a></li><li><a href="#show"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>show</span></a></li><li><a href="#valueFunction"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>value<wbr/>Function</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>