gojs
Version:
Interactive diagrams, charts, and graphs, such as trees, flowcharts, orgcharts, UML, BPMN, or business diagrams
384 lines • 58.4 kB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><link rel="stylesheet" href="../../assets/css/style.css"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DiagramRendererOptions | 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/search.js" id="tsd-search-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"</script><header>
<nav id="navTop" class="w-full z-30 top-0 text-white bg-nwoods-primary">
<div class="w-full max-w-screen-lg mx-auto flex flex-wrap sm:flex-nowrap items-center justify-between mt-0 py-2">
<div class="md:pl-4"><a class="text-white hover:text-white no-underline hover:no-underline font-bold text-2xl lg:text-4xl rounded-lg hover:bg-nwoods-secondary" href="../../index.html">
<h1 class="my-0 p-1 leading-none">GoJS</h1></a></div><button id="topnavButton" class="rounded-lg sm:hidden focus:outline-none focus:ring" aria-label="Navigation"><svg fill="currentColor" viewBox="0 0 20 20" class="w-6 h-6"><path id="topnavOpen" fill-rule="evenodd" d="M3 5a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zM3 10a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zM9 15a1 1 0 011-1h6a1 1 0 110 2h-6a1 1 0 01-1-1z" clip-rule="evenodd"></path><path id="topnavClosed" class="hidden" fill-rule="evenodd" d="M4.293 4.293a1 1 0 011.414 0L10 8.586l4.293-4.293a1 1 0 111.414 1.414L11.414 10l4.293 4.293a1 1 0 01-1.414 1.414L10 11.414l-4.293 4.293a1 1 0 01-1.414-1.414L8.586 10 4.293 5.707a1 1 0 010-1.414z" clip-rule="evenodd"></path></svg></button>
<div id="topnavList" class="hidden sm:block items-center w-auto mt-0 text-white p-0 z-20">
<ul class="list-reset list-none font-semibold flex justify-end flex-wrap sm:flex-nowrap items-center px-0 pb-0">
<li class="p-1 sm:p-0"><a class="topnav-link" href="../../learn/index.html">Learn</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="../../samples/index.html">Samples</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="../../intro/index.html">Intro</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="../../api/index.html">API</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/products/register.html">Register</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="../../download.html">Download</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="https://forum.nwoods.com/c/gojs/11">Forum</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/contact.html" target="_blank" rel="noopener" id="contactBtn">Contact</a></li>
<li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/sales/index.html" target="_blank" rel="noopener" id="buyBtn">Buy</a></li></ul></div></div><hr class="border-b border-gray-600 opacity-50 my-0 py-0"/></nav>
<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"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></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"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></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="DiagramRendererOptions.html">DiagramRendererOptions</a></li></ul>
<h1 class="flex items-center">Interface DiagramRendererOptions</h1></div>
<div class="text-xs"><b>GoJS</b>® Diagramming Components<br/>version 3.0.0a1<br/>by <a href="https://www.nwoods.com/">Northwoods Software®</a></div></div></div>
<section class="tsd-panel tsd-hierarchy">
<h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">DiagramRendererOptions</span>
<ul class="tsd-hierarchy">
<li><a href="ImageRendererOptions.html" class="tsd-signature-type tsd-kind-interface">ImageRendererOptions</a></li>
<li><a href="SvgRendererOptions.html" class="tsd-signature-type tsd-kind-interface">SvgRendererOptions</a></li></ul></li></ul></section>
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography"><p>Used for the options arguments to <a href="Diagram.html#makeImage" class="tsd-kind-method">Diagram.makeImage</a>, <a href="Diagram.html#makeImageData" class="tsd-kind-method">Diagram.makeImageData</a>, and <a href="Diagram.html#makeSvg" class="tsd-kind-method">Diagram.makeSvg</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"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
<div class="tsd-accordion-details">
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Properties</h3>
<div class="tsd-index-list"><a href="DiagramRendererOptions.html#background" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>background?</span></a>
<a href="DiagramRendererOptions.html#callback" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>callback?</span></a>
<a href="DiagramRendererOptions.html#callbackTimeout" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>callback<wbr/>Timeout?</span></a>
<a href="DiagramRendererOptions.html#document" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>document?</span></a>
<a href="DiagramRendererOptions.html#maxSize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>max<wbr/>Size?</span></a>
<a href="DiagramRendererOptions.html#padding" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>padding?</span></a>
<a href="DiagramRendererOptions.html#parts" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>parts?</span></a>
<a href="DiagramRendererOptions.html#position" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>position?</span></a>
<a href="DiagramRendererOptions.html#scale" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>scale?</span></a>
<a href="DiagramRendererOptions.html#showGrid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>show<wbr/>Grid?</span></a>
<a href="DiagramRendererOptions.html#showTemporary" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>show<wbr/>Temporary?</span></a>
<a href="DiagramRendererOptions.html#size" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>size?</span></a>
</div></section></div></details></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member"><a id="background" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>background</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="#background" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
<div class="tsd-comment tsd-typography"><p>A valid CSS color to replace the default (transparent) canvas background. Any padding area is also colored.</p>
</div></section>
<section class="tsd-panel tsd-member"><a id="callback" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>callback</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">result</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><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="#callback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures">
<li class="tsd-signature" id="callback.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">result</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>The function to call when an image is finished creation.
It has one argument, which is of the type specified by the value of the <a href="ImageRendererOptions.html#returnType" class="tsd-kind-property">ImageRendererOptions.returnType</a> or SVG DOM.
If provided, call the callback when finished instead of returning immediately. This can be useful if you need to wait for image assets to load.
This also respects the <a href="DiagramRendererOptions.html#callbackTimeout" class="tsd-kind-property">callbackTimeout</a>.
This argument is necessary if the <a href="ImageRendererOptions.html#returnType" class="tsd-kind-property">ImageRendererOptions.returnType</a> is <code>"blob"</code>, however a callback can be used with any <a href="ImageRendererOptions.html#returnType" class="tsd-kind-property">ImageRendererOptions.returnType</a>.
See the <a href="../../samples/minimalBlob.html">Minimal Image Blob Download sample</a> for an example usage,
which also demonstrates downloading an image file without involving a web server.</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">result</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section>
<section class="tsd-panel tsd-member"><a id="callbackTimeout" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>callback<wbr/>Timeout</span>
<div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#callbackTimeout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-comment tsd-typography"><p>If a <a href="DiagramRendererOptions.html#callback" class="tsd-kind-property">callback</a> is specified, the additional amount of time in milliseconds a call will wait before completeing. Right now, it will only wait if
image assets in the Diagram are not yet loaded. Default is 300 (milliseconds).</p>
</div></section>
<section class="tsd-panel tsd-member"><a id="document" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>document</span>
<div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Document</span></div><a href="#document" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-comment tsd-typography"><p>An HTML Document, defaulting to <code>window.document</code> (or the root object in other contexts)
This may be useful to set if you intend your Image or SVG to be opened in a new window.</p>
</div></section>
<section class="tsd-panel tsd-member"><a id="maxSize" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>max<wbr/>Size</span>
<div class="membertype"><span class="tsd-signature-symbol">: </span><a href="Size.html" class="tsd-signature-type tsd-kind-class">Size</a></div><a href="#maxSize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-comment tsd-typography"><p>The maximum size of the created image, as a <a href="Size.html" class="tsd-kind-class">Size</a>.
The default value is <code>(Infinity, Infinity)</code> for SVG and <code>(2000, 2000)</code> for images.
This is typically used when <a href="DiagramRendererOptions.html#scale" class="tsd-kind-property">scale</a> is specified and helps prevent accidental excessive memory usage,
which is especially needed in limited-memory environments.
You cannot use Infinity when providing a maximum size for an image -- consider calling <a href="Diagram.html#makeSvg" class="tsd-kind-method">Diagram.makeSvg</a> instead.</p>
</div></section>
<section class="tsd-panel tsd-member"><a id="padding" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>padding</span>
<div class="membertype"><span class="tsd-signature-symbol">: </span><a href="MarginLike.html" class="tsd-signature-type tsd-kind-type-alias">MarginLike</a></div><a href="#padding" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-comment tsd-typography"><p>A <a href="Margin.html" class="tsd-kind-class">Margin</a> (or number) to pad the image with. If a size is specified,
the padding will not increase the image size, it will only offset the Diagram contents within the image.
The default value is a padding of <code>1</code>.</p>
</div></section>
<section class="tsd-panel tsd-member"><a id="parts" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>parts</span>
<div class="membertype"><span class="tsd-signature-symbol">: </span><a href="Iterable.html" class="tsd-signature-type tsd-kind-interface">Iterable</a><span class="tsd-signature-symbol"><</span><a href="Part.html" class="tsd-signature-type tsd-kind-class">Part</a><span class="tsd-signature-symbol">></span></div><a href="#parts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-comment tsd-typography"><p>An iterator of <a href="GraphObject.html" class="tsd-kind-class">GraphObject</a>s, typically <a href="Part.html" class="tsd-kind-class">Part</a>s, such as one from <a href="Diagram.html#selection" class="tsd-kind-accessor">Diagram.selection</a> or <a href="Layer.html#parts" class="tsd-kind-accessor">Layer.parts</a>.
If GraphObjects are specified their containing Part will be drawn. By default all Parts are drawn except temporary parts (see <a href="DiagramRendererOptions.html#showTemporary" class="tsd-kind-property">showTemporary</a>).</p>
</div></section>
<section class="tsd-panel tsd-member"><a id="position" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>position</span>
<div class="membertype"><span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type tsd-kind-class">Point</a></div><a href="#position" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-comment tsd-typography"><p>The position of the diagram, as a <a href="Point.html" class="tsd-kind-class">Point</a>.
By default this is the position of <a href="Diagram.html#documentBounds" class="tsd-kind-accessor">Diagram.documentBounds</a> with the <a href="Diagram.html#padding" class="tsd-kind-accessor">Diagram.padding</a> removed.
If a specific parts collection is used, by default this is the top-left diagram position of their collective bounds.
If you set a position, you should also set a <a href="DiagramRendererOptions.html#size" class="tsd-kind-property">size</a>.</p>
</div></section>
<section class="tsd-panel tsd-member"><a id="scale" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>scale</span>
<div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></div><a href="#scale" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-comment tsd-typography"><p>The scale of the diagram. If <a href="DiagramRendererOptions.html#scale" class="tsd-kind-property">scale</a> is specified and <a href="DiagramRendererOptions.html#size" class="tsd-kind-property">size</a> is not, the resulting image will be sized to uniformly
fit the space needed for the given scale.
Can be constrained by the <a href="DiagramRendererOptions.html#maxSize" class="tsd-kind-property">maxSize</a> property. A scale value of <code>NaN</code> will
automatically scale to fit within the maxSize, but may be smaller, with a maximum computed scale of 1.</p>
</div></section>
<section class="tsd-panel tsd-member"><a id="showGrid" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>show<wbr/>Grid</span>
<div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></div><a href="#showGrid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-comment tsd-typography"><p>A boolean value, defaulting to the value of <strong>showTemporary</strong>,
that determines whether or not the Grid Layer (containing <a href="Diagram.html#grid" class="tsd-kind-accessor">Diagram.grid</a>) is included in the image
regardless of the value of <a href="DiagramRendererOptions.html#showTemporary" class="tsd-kind-property">showTemporary</a>.
This is useful if you want to include the grid but not adornments, or vice versa.</p>
</div></section>
<section class="tsd-panel tsd-member"><a id="showTemporary" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>show<wbr/>Temporary</span>
<div class="membertype"><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></div><a href="#showTemporary" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-comment tsd-typography"><p>A boolean value, defaulting to false,
that determines whether or not temporary objects such as adornments are included in the image.</p>
</div></section>
<section class="tsd-panel tsd-member"><a id="size" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>size</span>
<div class="membertype"><span class="tsd-signature-symbol">: </span><a href="Size.html" class="tsd-signature-type tsd-kind-class">Size</a></div><a href="#size" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-comment tsd-typography"><p>The size of the created image, as a <a href="Size.html" class="tsd-kind-class">Size</a>, limited by the <a href="DiagramRendererOptions.html#maxSize" class="tsd-kind-property">maxSize</a> property.
If no <a href="DiagramRendererOptions.html#scale" class="tsd-kind-property">scale</a> or <a href="DiagramRendererOptions.html#position" class="tsd-kind-property">position</a> is specified then the diagram will be scaled to fit the given size.
If you set a size, you should also set a <a href="DiagramRendererOptions.html#position" class="tsd-kind-property">position</a>. If you are scaling the diagram, you may also want to scale the size.</p>
</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"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>On This Page</h3></summary>
<div class="tsd-accordion-details">
<ul>
<li><a href="#background" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>background</span></a></li>
<li><a href="#callback" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>callback</span></a></li>
<li><a href="#callbackTimeout" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>callback<wbr/>Timeout</span></a></li>
<li><a href="#document" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>document</span></a></li>
<li><a href="#maxSize" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>max<wbr/>Size</span></a></li>
<li><a href="#padding" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>padding</span></a></li>
<li><a href="#parts" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>parts</span></a></li>
<li><a href="#position" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>position</span></a></li>
<li><a href="#scale" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>scale</span></a></li>
<li><a href="#showGrid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>show<wbr/>Grid</span></a></li>
<li><a href="#showTemporary" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>show<wbr/>Temporary</span></a></li>
<li><a href="#size" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>size</span></a></li></ul></div></details>
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg> Settings</h3></summary>
<div class="tsd-accordion-details">
<div class="tsd-theme-toggle">
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
<div class="site-menu">
<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>GoJS API</span></a>
<ul class="tsd-small-nested-navigation">
<li>
<details class="tsd-index-accordion" data-key="Classes"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Classes</span></summary>
<div class="tsd-accordion-details">
<ul class="tsd-nested-navigation">
<li>
<details class="tsd-index-accordion" data-key="Classes$Diagram"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Diagram</span></summary>
<div class="tsd-accordion-details">
<ul class="tsd-nested-navigation">
<li><a href="Adornment.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Adornment</span></a></li>
<li><a href="Animation.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Animation</span></a></li>
<li><a href="AnimationManager.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Animation<wbr/>Manager</span></a></li>
<li><a href="AnimationTrigger.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Animation<wbr/>Trigger</span></a></li>
<li><a href="CommandHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Command<wbr/>Handler</span></a></li>
<li><a href="Diagram.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Diagram</span></a></li>
<li><a href="DiagramEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Diagram<wbr/>Event</span></a></li>
<li><a href="DraggingInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Dragging<wbr/>Info</span></a></li>
<li><a href="DraggingOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Dragging<wbr/>Options</span></a></li>
<li><a href="GraphObject.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Graph<wbr/>Object</span></a></li>
<li><a href="Group.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Group</span></a></li>
<li><a href="InputEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Input<wbr/>Event</span></a></li>
<li><a href="Layer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Layer</span></a></li>
<li><a href="Link.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Link</span></a></li>
<li><a href="Node.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Node</span></a></li>
<li><a href="Overview.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Overview</span></a></li>
<li><a href="Palette.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Palette</span></a></li>
<li><a href="Panel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Panel</span></a></li>
<li><a href="PanelLayout.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Panel<wbr/>Layout</span></a></li>
<li><a href="Part.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Part</span></a></li>
<li><a href="Picture.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Picture</span></a></li>
<li><a href="Placeholder.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Placeholder</span></a></li>
<li><a href="RowColumnDefinition.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Row<wbr/>Column<wbr/>Definition</span></a></li>
<li><a href="Shape.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Shape</span></a></li>
<li><a href="TextBlock.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Text<wbr/>Block</span></a></li></ul></div></details></li>
<li>
<details class="tsd-index-accordion" data-key="Classes$Geometry"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Geometry</span></summary>
<div class="tsd-accordion-details">
<ul class="tsd-nested-navigation">
<li><a href="Brush.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Brush</span></a></li>
<li><a href="Geometry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Geometry</span></a></li>
<li><a href="Margin.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Margin</span></a></li>
<li><a href="PathFigure.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Path<wbr/>Figure</span></a></li>
<li><a href="PathSegment.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Path<wbr/>Segment</span></a></li>
<li><a href="Point.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Point</span></a></li>
<li><a href="Rect.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Rect</span></a></li>
<li><a href="Size.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Size</span></a></li>
<li><a href="Spot.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Spot</span></a></li></ul></div></details></li>
<li>
<details class="tsd-index-accordion" data-key="Classes$Model"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Model</span></summary>
<div class="tsd-accordion-details">
<ul class="tsd-nested-navigation">
<li><a href="Binding.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Binding</span></a></li>
<li><a href="ChangedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Changed<wbr/>Event</span></a></li>
<li><a href="GraphLinksModel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Graph<wbr/>Links<wbr/>Model</span></a></li>
<li><a href="Model.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Model</span></a></li>
<li><a href="Transaction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Transaction</span></a></li>
<li><a href="TreeModel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Tree<wbr/>Model</span></a></li>
<li><a href="UndoManager.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Undo<wbr/>Manager</span></a></li></ul></div></details></li>
<li>
<details class="tsd-index-accordion" data-key="Classes$Layout"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Layout</span></summary>
<div class="tsd-accordion-details">
<ul class="tsd-nested-navigation">
<li><a href="CircularLayout.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Circular<wbr/>Layout</span></a></li>
<li><a href="ForceDirectedLayout.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Force<wbr/>Directed<wbr/>Layout</span></a></li>
<li><a href="GridLayout.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Grid<wbr/>Layout</span></a></li>
<li><a href="LayeredDigraphLayout.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Layered<wbr/>Digraph<wbr/>Layout</span></a></li>
<li><a href="Layout.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Layout</span></a></li>
<li><a href="LayoutEdge.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Layout<wbr/>Edge</span></a></li>
<li><a href="LayoutNetwork.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Layout<wbr/>Network</span></a></li>
<li><a href="LayoutVertex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Layout<wbr/>Vertex</span></a></li>
<li><a href="TreeLayout.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Tree<wbr/>Layout</span></a></li></ul></div></details></li>
<li>
<details class="tsd-index-accordion" data-key="Classes$Tool"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Tool</span></summary>
<div class="tsd-accordion-details">
<ul class="tsd-nested-navigation">
<li><a href="ActionTool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Action<wbr/>Tool</span></a></li>
<li><a href="ClickCreatingTool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Click<wbr/>Creating<wbr/>Tool</span></a></li>
<li><a href="ClickSelectingTool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Click<wbr/>Selecting<wbr/>Tool</span></a></li>
<li><a href="ContextMenuTool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Context<wbr/>Menu<wbr/>Tool</span></a></li>
<li><a href="DragSelectingTool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Drag<wbr/>Selecting<wbr/>Tool</span></a></li>
<li><a href="DraggingTool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Dragging<wbr/>Tool</span></a></li>
<li><a href="HTMLInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>HTMLInfo</span></a></li>
<li><a href="LinkReshapingTool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Link<wbr/>Reshaping<wbr/>Tool</span></a></li>
<li><a href="LinkingBaseTool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Linking<wbr/>Base<wbr/>Tool</span></a></li>
<li><a href="LinkingTool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Linking<wbr/>Tool</span></a></li>
<li><a href="PanningTool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Panning<wbr/>Tool</span></a></li>
<li><a href="RelinkingTool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Relinking<wbr/>Tool</span></a></li>
<li><a href="ResizingTool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Resizing<wbr/>Tool</span></a></li>
<li><a href="RotatingTool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Rotating<wbr/>Tool</span></a></li>
<li><a href="TextEditingTool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Text<wbr/>Editing<wbr/>Tool</span></a></li>
<li><a href="Tool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Tool</span></a></li>
<li><a href="ToolManager.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Tool<wbr/>Manager</span></a></li></ul></div></details></li>
<li>
<details class="tsd-index-accordion" data-key="Classes$Collection"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Collection</span></summary>
<div class="tsd-accordion-details">
<ul class="tsd-nested-navigation">
<li><a href="List.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>List</span></a></li>
<li><a href="Map.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Map</span></a></li>
<li><a href="Set.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Set</span></a></li></ul></div></details></li>
<li></li>
<li></li>
<li></li>
<li></li></ul></div></details></li>
<li>
<details class="tsd-index-accordion" data-key="Interfaces"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Interfaces</span></summary>
<div class="tsd-accordion-details">
<ul class="tsd-nested-navigation">
<li>
<details class="tsd-index-accordion" data-key="Interfaces$Diagram"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Diagram</span></summary>
<div class="tsd-accordion-details">
<ul class="tsd-nested-navigation">
<li><a href="DiagramRendererOptions.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Diagram<wbr/>Renderer<wbr/>Options</span></a></li>
<li><a href="ImageRendererOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Image<wbr/>Renderer<wbr/>Options</span></a></li>
<li><a href="SvgRendererOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Svg<wbr/>Renderer<wbr/>Options</span></a></li></ul></div></details></li>
<li>
<details class="tsd-index-accordion" data-key="Interfaces$Model"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Model</span></summary>
<div class="tsd-accordion-details">
<ul class="tsd-nested-navigation">
<li><a href="IncrementalData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Incremental<wbr/>Data</span></a></li>
<li><a href="ObjectData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Object<wbr/>Data</span></a></li></ul></div></details></li>
<li>
<details class="tsd-index-accordion" data-key="Interfaces$Collection"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Collection</span></summary>
<div class="tsd-accordion-details">
<ul class="tsd-nested-navigation">
<li><a href="IKeyValuePair.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IKey<wbr/>Value<wbr/>Pair</span></a></li>
<li><a href="IMapIterator.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IMap<wbr/>Iterator</span></a></li>
<li><a href="Iterable.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Iterable</span></a></li>
<li><a href="Iterator.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Iterator</span></a></li></ul></div></details></li></ul></div></details></li>
<li>
<details class="tsd-index-accordion" data-key="Enumerations"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Enumerations</span></summary>
<div class="tsd-accordion-details">
<ul class="tsd-nested-navigation">
<li>
<details class="tsd-index-accordion" data-key="Enumerations$Diagram"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Diagram</span></summary>
<div class="tsd-accordion-details">
<ul class="tsd-nested-navigation">
<li><a href="AnimationStyle.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g></svg><span>Animation<wbr/>Style</span></a></li>
<li><a href="AutoScale.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Auto<wbr/>Scale</span></a></li>
<li><a href="CycleMode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Cycle<wbr/>Mode</span></a></li>
<li><a href="Flip.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Flip</span></a></li>
<li><a href="Format.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Format</span></a></li>
<li><a href="ImageStretch.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Image<wbr/>Stretch</span></a></li>
<li><a href="LayoutConditions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Layout<wbr/>Conditions</span></a></li>
<li><a href="LinkAdjusting.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Link<wbr/>Adjusting</span></a></li>
<li><a href="LinkCurve.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Link<wbr/>Curve</span></a></li>
<li><a href="LinkRouting.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Link<wbr/>Routing</span></a></li>
<li><a href="Orientation.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Orientation</span></a></li>
<li><a href="Overflow.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Overflow</span></a></li>
<li><a href="PanelType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Panel<wbr/>Type</span></a></li>
<li><a href="PortSpreading.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Port<wbr/>Spreading</span></a></li>
<li><a href="ScrollMode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Scroll<wbr/>Mode</span></a></li>
<li><a href="Sizing.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Sizing</span></a></li>
<li><a href="StartCondition.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Start<wbr/>Condition</span></a></li>
<li><a href="Stretch.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Stretch</span></a></li>
<li><a href="ViewboxStretch.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Viewbox<wbr/>Stretch</span></a></li>
<li><a href="Wrap.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Wrap</span></a></li></ul></div></details></li>
<li>
<details class="tsd-index-accordion" data-key="Enumerations$Geometry"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Geometry</span></summary>
<div class="tsd-accordion-details">
<ul class="tsd-nested-navigation">
<li><a href="BrushType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Brush<wbr/>Type</span></a></li>
<li><a href="ColorSpace.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Color<wbr/>Space</span></a></li>
<li><a href="GeometryStretch.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Geometry<wbr/>Stretch</span></a></li>
<li><a href="GeometryType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Geometry<wbr/>Type</span></a></li>
<li><a href="SegmentType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Segment<wbr/>Type</span></a></li></ul></div></details></li>
<li>
<details class="tsd-index-accordion" data-key="Enumerations$Model"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Model</span></summary>
<div class="tsd-accordion-details">
<ul class="tsd-nested-navigation">
<li><a href="BindingMode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Binding<wbr/>Mode</span></a></li>
<li><a href="ChangeType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Change<wbr/>Type</span></a></li></ul></div></details></li>
<li>
<details class="tsd-index-accordion" data-key="Enumerations$Layout"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Layout</span></summary>
<di