83 lines
60 KiB
HTML
83 lines
60 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Outline | @maxgraph/core</title><meta name="description" content="Documentation for @maxgraph/core"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@maxgraph/core</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">@maxgraph/core</a></li><li><a href="Outline.html">Outline</a></li></ul><h1>Class Outline</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Outline</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Outline.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#active" class="tsd-kind-icon">active</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#border" class="tsd-kind-icon">border</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#bounds" class="tsd-kind-icon">bounds</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#dx0" class="tsd-kind-icon">dx0</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#dy0" class="tsd-kind-icon">dy0</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#graphRenderHint" class="tsd-kind-icon">graph<wbr/>Render<wbr/>Hint</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#index" class="tsd-kind-icon">index</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#labelsVisible" class="tsd-kind-icon">labels<wbr/>Visible</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#minScale" class="tsd-kind-icon">min<wbr/>Scale</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#outline" class="tsd-kind-icon">outline</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#panHandler" class="tsd-kind-icon">pan<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#refreshHandler" class="tsd-kind-icon">refresh<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#selectionBorder" class="tsd-kind-icon">selection<wbr/>Border</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#showViewport" class="tsd-kind-icon">show<wbr/>Viewport</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#sizer" class="tsd-kind-icon">sizer</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#sizerImage" class="tsd-kind-icon">sizer<wbr/>Image</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#sizerSize" class="tsd-kind-icon">sizer<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#source" class="tsd-kind-icon">source</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#startX" class="tsd-kind-icon">startX</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#startY" class="tsd-kind-icon">startY</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#suspended" class="tsd-kind-icon">suspended</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#updateHandler" class="tsd-kind-icon">update<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#updateOnPan" class="tsd-kind-icon">update<wbr/>On<wbr/>Pan</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#zoom" class="tsd-kind-icon">zoom</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#createGraph" class="tsd-kind-icon">create<wbr/>Graph</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#createSizer" class="tsd-kind-icon">create<wbr/>Sizer</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#getOutlineOffset" class="tsd-kind-icon">get<wbr/>Outline<wbr/>Offset</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#getSourceContainerSize" class="tsd-kind-icon">get<wbr/>Source<wbr/>Container<wbr/>Size</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#getSourceGraphBounds" class="tsd-kind-icon">get<wbr/>Source<wbr/>Graph<wbr/>Bounds</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#getTranslateForEvent" class="tsd-kind-icon">get<wbr/>Translate<wbr/>For<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#init" class="tsd-kind-icon">init</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#isEnabled" class="tsd-kind-icon">is<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#mouseDown" class="tsd-kind-icon">mouse<wbr/>Down</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#mouseMove" class="tsd-kind-icon">mouse<wbr/>Move</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#mouseUp" class="tsd-kind-icon">mouse<wbr/>Up</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#refresh" class="tsd-kind-icon">refresh</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#setEnabled" class="tsd-kind-icon">set<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#setZoomEnabled" class="tsd-kind-icon">set<wbr/>Zoom<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#update" class="tsd-kind-icon">update</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Outline<span class="tsd-signature-symbol">(</span>source<span class="tsd-signature-symbol">: </span><a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a>, container<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Outline.html" class="tsd-signature-type" data-tsd-kind="Class">Outline</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L72">view/other/Outline.ts:72</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>source: <a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a></h5></li><li><h5>container: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol"> = null</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Outline.html" class="tsd-signature-type" data-tsd-kind="Class">Outline</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="active" class="tsd-anchor"></a><h3>active</h3><div class="tsd-signature tsd-kind-icon">active<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L207">view/other/Outline.ts:207</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="border" class="tsd-anchor"></a><h3>border</h3><div class="tsd-signature tsd-kind-icon">border<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 10</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L255">view/other/Outline.ts:255</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Border to be added at the bottom and right.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>10</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="bounds" class="tsd-anchor"></a><h3>bounds</h3><div class="tsd-signature tsd-kind-icon">bounds<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Rectangle.html" class="tsd-signature-type" data-tsd-kind="Class">Rectangle</a><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L209">view/other/Outline.ts:209</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="dx0" class="tsd-anchor"></a><h3>dx0</h3><div class="tsd-signature tsd-kind-icon">dx0<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L217">view/other/Outline.ts:217</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="dy0" class="tsd-anchor"></a><h3>dy0</h3><div class="tsd-signature tsd-kind-icon">dy0<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L219">view/other/Outline.ts:219</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="enabled" class="tsd-anchor"></a><h3>enabled</h3><div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L243">view/other/Outline.ts:243</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies if events are handled.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>true</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="graphRenderHint" class="tsd-anchor"></a><h3>graph<wbr/>Render<wbr/>Hint</h3><div class="tsd-signature tsd-kind-icon">graph<wbr/>Render<wbr/>Hint<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'exact'</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L237">view/other/Outline.ts:237</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Renderhint to be used for the outline graph.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>faster</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="index" class="tsd-anchor"></a><h3>index</h3><div class="tsd-signature tsd-kind-icon">index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L221">view/other/Outline.ts:221</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="labelsVisible" class="tsd-anchor"></a><h3>labels<wbr/>Visible</h3><div class="tsd-signature tsd-kind-icon">labels<wbr/>Visible<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L267">view/other/Outline.ts:267</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies if labels should be visible in the outline.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>false</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="minScale" class="tsd-anchor"></a><h3>min<wbr/>Scale</h3><div class="tsd-signature tsd-kind-icon">min<wbr/>Scale<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0.0001</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L286">view/other/Outline.ts:286</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Minimum scale to be used.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>0.0001</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="outline" class="tsd-anchor"></a><h3>outline</h3><div class="tsd-signature tsd-kind-icon">outline<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L231">view/other/Outline.ts:231</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Reference to the {@link graph} that renders the outline.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="panHandler" class="tsd-anchor"></a><h3>pan<wbr/>Handler</h3><div class="tsd-signature tsd-kind-icon">pan<wbr/>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>sender<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, evt<span class="tsd-signature-symbol">: </span><a href="EventObject.html" class="tsd-signature-type" data-tsd-kind="Class">EventObject</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><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L205">view/other/Outline.ts:205</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="refreshHandler" class="tsd-anchor"></a><h3>refresh<wbr/>Handler</h3><div class="tsd-signature tsd-kind-icon">refresh<wbr/>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>sender<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, evt<span class="tsd-signature-symbol">: </span><a href="EventObject.html" class="tsd-signature-type" data-tsd-kind="Class">EventObject</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><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L203">view/other/Outline.ts:203</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="selectionBorder" class="tsd-anchor"></a><h3>selection<wbr/>Border</h3><div class="tsd-signature tsd-kind-icon">selection<wbr/>Border<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="RectangleShape.html" class="tsd-signature-type" data-tsd-kind="Class">RectangleShape</a><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L199">view/other/Outline.ts:199</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="showViewport" class="tsd-anchor"></a><h3>show<wbr/>Viewport</h3><div class="tsd-signature tsd-kind-icon">show<wbr/>Viewport<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L249">view/other/Outline.ts:249</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies a viewport rectangle should be shown.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>true</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="sizer" class="tsd-anchor"></a><h3>sizer</h3><div class="tsd-signature tsd-kind-icon">sizer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="RectangleShape.html" class="tsd-signature-type" data-tsd-kind="Class">RectangleShape</a><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L197">view/other/Outline.ts:197</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="sizerImage" class="tsd-anchor"></a><h3>sizer<wbr/>Image</h3><div class="tsd-signature tsd-kind-icon">sizer<wbr/>Image<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="ImageBox.html" class="tsd-signature-type" data-tsd-kind="Class">ImageBox</a><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L280">view/other/Outline.ts:280</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Optional {@link Image} to be used for the sizer.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>null</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="sizerSize" class="tsd-anchor"></a><h3>sizer<wbr/>Size</h3><div class="tsd-signature tsd-kind-icon">sizer<wbr/>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 8</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L261">view/other/Outline.ts:261</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies the size of the sizer handler.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>8</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="source" class="tsd-anchor"></a><h3>source</h3><div class="tsd-signature tsd-kind-icon">source<span class="tsd-signature-symbol">:</span> <a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L226">view/other/Outline.ts:226</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Reference to the source {@link graph}.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="startX" class="tsd-anchor"></a><h3>startX</h3><div class="tsd-signature tsd-kind-icon">startX<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L213">view/other/Outline.ts:213</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="startY" class="tsd-anchor"></a><h3>startY</h3><div class="tsd-signature tsd-kind-icon">startY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L215">view/other/Outline.ts:215</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="suspended" class="tsd-anchor"></a><h3>suspended</h3><div class="tsd-signature tsd-kind-icon">suspended<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L305">view/other/Outline.ts:305</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Optional boolean flag to suspend updates. This flag will
|
|
also suspend repaints of the outline. To toggle this switch, use the
|
|
following code.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>false</p>
|
|
</dd><dt>example</dt><dd><pre><code class="language-javascript"><span class="hl-0">nav</span><span class="hl-1">.</span><span class="hl-0">suspended</span><span class="hl-1"> = !</span><span class="hl-0">nav</span><span class="hl-1">.</span><span class="hl-0">suspended</span><span class="hl-1">;</span><br/><br/><span class="hl-5">if</span><span class="hl-1"> (!</span><span class="hl-0">nav</span><span class="hl-1">.</span><span class="hl-0">suspended</span><span class="hl-1">)</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-0">nav</span><span class="hl-1">.</span><span class="hl-2">update</span><span class="hl-1">(</span><span class="hl-3">true</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
|
|
</code></pre>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="updateHandler" class="tsd-anchor"></a><h3>update<wbr/>Handler</h3><div class="tsd-signature tsd-kind-icon">update<wbr/>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>sender<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, evt<span class="tsd-signature-symbol">: </span><a href="EventObject.html" class="tsd-signature-type" data-tsd-kind="Class">EventObject</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><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L201">view/other/Outline.ts:201</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="updateOnPan" class="tsd-anchor"></a><h3>update<wbr/>On<wbr/>Pan</h3><div class="tsd-signature tsd-kind-icon">update<wbr/>On<wbr/>Pan<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L274">view/other/Outline.ts:274</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies if <a href="Outline.html#update">update</a> should be called for <a href="InternalEvent.html#PAN">InternalEvent.PAN</a> in the source
|
|
graph.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>false</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="zoom" class="tsd-anchor"></a><h3>zoom</h3><div class="tsd-signature tsd-kind-icon">zoom<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L211">view/other/Outline.ts:211</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createGraph" class="tsd-anchor"></a><h3>create<wbr/>Graph</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>Graph<span class="tsd-signature-symbol">(</span>container<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L310">view/other/Outline.ts:310</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Creates the {@link graph} used in the outline.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>container: <span class="tsd-signature-type">HTMLElement</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createSizer" class="tsd-anchor"></a><h3>create<wbr/>Sizer</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>Sizer<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="RectangleShape.html" class="tsd-signature-type" data-tsd-kind="Class">RectangleShape</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L362">view/other/Outline.ts:362</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Creates the shape used as the sizer.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <a href="RectangleShape.html" class="tsd-signature-type" data-tsd-kind="Class">RectangleShape</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="destroy" class="tsd-anchor"></a><h3>destroy</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">destroy<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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L729">view/other/Outline.ts:729</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Destroy this outline and removes all listeners from <a href="Outline.html#source">source</a>.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getOutlineOffset" class="tsd-anchor"></a><h3>get<wbr/>Outline<wbr/>Offset</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Outline<wbr/>Offset<span class="tsd-signature-symbol">(</span>scale<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">null</span><span class="tsd-signature-symbol"> | </span><a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L397">view/other/Outline.ts:397</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the offset for drawing the outline graph.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> scale: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getSourceContainerSize" class="tsd-anchor"></a><h3>get<wbr/>Source<wbr/>Container<wbr/>Size</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Source<wbr/>Container<wbr/>Size<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Rectangle.html" class="tsd-signature-type" data-tsd-kind="Class">Rectangle</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L385">view/other/Outline.ts:385</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the size of the source container.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <a href="Rectangle.html" class="tsd-signature-type" data-tsd-kind="Class">Rectangle</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getSourceGraphBounds" class="tsd-anchor"></a><h3>get<wbr/>Source<wbr/>Graph<wbr/>Bounds</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Source<wbr/>Graph<wbr/>Bounds<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Rectangle.html" class="tsd-signature-type" data-tsd-kind="Class">Rectangle</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L405">view/other/Outline.ts:405</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the offset for drawing the outline graph.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <a href="Rectangle.html" class="tsd-signature-type" data-tsd-kind="Class">Rectangle</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getTranslateForEvent" class="tsd-anchor"></a><h3>get<wbr/>Translate<wbr/>For<wbr/>Event</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Translate<wbr/>For<wbr/>Event<span class="tsd-signature-symbol">(</span>me<span class="tsd-signature-symbol">: </span><a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L682">view/other/Outline.ts:682</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Gets the translate for the given mouse event. Here is an example to limit
|
|
the outline to stay within positive coordinates:</p>
|
|
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-javascript"><span class="hl-0">outline</span><span class="hl-1">.</span><span class="hl-2">getTranslateForEvent</span><span class="hl-1">(</span><span class="hl-0">me</span><span class="hl-1">)</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-3">var</span><span class="hl-1"> </span><span class="hl-0">pt</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-2">mxPoint</span><span class="hl-1">(</span><span class="hl-0">me</span><span class="hl-1">.</span><span class="hl-2">getX</span><span class="hl-1">() - </span><span class="hl-3">this</span><span class="hl-1">.</span><span class="hl-0">startX</span><span class="hl-1">, </span><span class="hl-0">me</span><span class="hl-1">.</span><span class="hl-2">getY</span><span class="hl-1">() - </span><span class="hl-3">this</span><span class="hl-1">.</span><span class="hl-0">startY</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1"> (!</span><span class="hl-3">this</span><span class="hl-1">.</span><span class="hl-0">zoom</span><span class="hl-1">)</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">var</span><span class="hl-1"> </span><span class="hl-0">tr</span><span class="hl-1"> = </span><span class="hl-3">this</span><span class="hl-1">.</span><span class="hl-0">source</span><span class="hl-1">.</span><span class="hl-0">view</span><span class="hl-1">.</span><span class="hl-0">translate</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">pt</span><span class="hl-1">.</span><span class="hl-0">x</span><span class="hl-1"> = </span><span class="hl-10">Math</span><span class="hl-1">.</span><span class="hl-2">max</span><span class="hl-1">(</span><span class="hl-0">tr</span><span class="hl-1">.</span><span class="hl-0">x</span><span class="hl-1"> * </span><span class="hl-3">this</span><span class="hl-1">.</span><span class="hl-0">outline</span><span class="hl-1">.</span><span class="hl-0">view</span><span class="hl-1">.</span><span class="hl-0">scale</span><span class="hl-1">, </span><span class="hl-0">pt</span><span class="hl-1">.</span><span class="hl-0">x</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">pt</span><span class="hl-1">.</span><span class="hl-0">y</span><span class="hl-1"> = </span><span class="hl-10">Math</span><span class="hl-1">.</span><span class="hl-2">max</span><span class="hl-1">(</span><span class="hl-0">tr</span><span class="hl-1">.</span><span class="hl-0">y</span><span class="hl-1"> * </span><span class="hl-3">this</span><span class="hl-1">.</span><span class="hl-0">outline</span><span class="hl-1">.</span><span class="hl-0">view</span><span class="hl-1">.</span><span class="hl-0">scale</span><span class="hl-1">, </span><span class="hl-0">pt</span><span class="hl-1">.</span><span class="hl-0">y</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-5">return</span><span class="hl-1"> </span><span class="hl-0">pt</span><span class="hl-1">;</span><br/><span class="hl-1">};</span>
|
|
</code></pre>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>me: <a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="init" class="tsd-anchor"></a><h3>init</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">init<span class="tsd-signature-symbol">(</span>container<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L83">view/other/Outline.ts:83</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Initializes the outline inside the given container.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>container: <span class="tsd-signature-type">HTMLElement</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isEnabled" class="tsd-anchor"></a><h3>is<wbr/>Enabled</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Enabled<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L326">view/other/Outline.ts:326</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns true if events are handled. This implementation
|
|
returns <a href="Outline.html#enabled">enabled</a>.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="mouseDown" class="tsd-anchor"></a><h3>mouse<wbr/>Down</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">mouse<wbr/>Down<span class="tsd-signature-symbol">(</span>sender<span class="tsd-signature-symbol">: </span><a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a>, me<span class="tsd-signature-symbol">: </span><a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L562">view/other/Outline.ts:562</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Handles the event by starting a translation or zoom.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>sender: <a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a></h5></li><li><h5>me: <a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="mouseMove" class="tsd-anchor"></a><h3>mouse<wbr/>Move</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">mouse<wbr/>Move<span class="tsd-signature-symbol">(</span>sender<span class="tsd-signature-symbol">: </span><a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a>, me<span class="tsd-signature-symbol">: </span><a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L594">view/other/Outline.ts:594</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Handles the event by previewing the viewrect in {@link graph} and updating the
|
|
rectangle that represents the viewrect in the outline.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>sender: <a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a></h5></li><li><h5>me: <a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="mouseUp" class="tsd-anchor"></a><h3>mouse<wbr/>Up</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">mouse<wbr/>Up<span class="tsd-signature-symbol">(</span>sender<span class="tsd-signature-symbol">: </span><a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a>, me<span class="tsd-signature-symbol">: </span><a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L689">view/other/Outline.ts:689</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Handles the event by applying the translation or zoom to {@link graph}.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>sender: <a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a></h5></li><li><h5>me: <a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="refresh" class="tsd-anchor"></a><h3>refresh</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">refresh<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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L354">view/other/Outline.ts:354</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Invokes <a href="Outline.html#update">update</a> and revalidate the outline. This method is deprecated.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setEnabled" class="tsd-anchor"></a><h3>set<wbr/>Enabled</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Enabled<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L336">view/other/Outline.ts:336</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Enables or disables event handling. This implementation
|
|
updates <a href="Outline.html#enabled">enabled</a>.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Boolean that specifies the new enabled state.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setZoomEnabled" class="tsd-anchor"></a><h3>set<wbr/>Zoom<wbr/>Enabled</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Zoom<wbr/>Enabled<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L346">view/other/Outline.ts:346</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Enables or disables the zoom handling by showing or hiding the respective
|
|
handle.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Boolean that specifies the new enabled state.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="update" class="tsd-anchor"></a><h3>update</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">update<span class="tsd-signature-symbol">(</span>revalidate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/other/Outline.ts#L412">view/other/Outline.ts:412</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Updates the outline.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>revalidate: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/DomHelpers.html">Dom<wbr/>Helpers</a></li><li class=" tsd-kind-namespace"><a href="../modules/cloneUtils.html">clone<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/constants.html">constants</a></li><li class=" tsd-kind-namespace"><a href="../modules/domUtils.html">dom<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/eventUtils.html">event<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/gestureUtils.html">gesture<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/mathUtils.html">math<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/stringUtils.html">string<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/styleUtils.html">style<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/utils.html">utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/xmlUtils.html">xml<wbr/>Utils</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="Outline.html" class="tsd-kind-icon">Outline</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Outline.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#active" class="tsd-kind-icon">active</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#border" class="tsd-kind-icon">border</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#bounds" class="tsd-kind-icon">bounds</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#dx0" class="tsd-kind-icon">dx0</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#dy0" class="tsd-kind-icon">dy0</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#graphRenderHint" class="tsd-kind-icon">graph<wbr/>Render<wbr/>Hint</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#index" class="tsd-kind-icon">index</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#labelsVisible" class="tsd-kind-icon">labels<wbr/>Visible</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#minScale" class="tsd-kind-icon">min<wbr/>Scale</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#outline" class="tsd-kind-icon">outline</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#panHandler" class="tsd-kind-icon">pan<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#refreshHandler" class="tsd-kind-icon">refresh<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#selectionBorder" class="tsd-kind-icon">selection<wbr/>Border</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#showViewport" class="tsd-kind-icon">show<wbr/>Viewport</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#sizer" class="tsd-kind-icon">sizer</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#sizerImage" class="tsd-kind-icon">sizer<wbr/>Image</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#sizerSize" class="tsd-kind-icon">sizer<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#source" class="tsd-kind-icon">source</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#startX" class="tsd-kind-icon">startX</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#startY" class="tsd-kind-icon">startY</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#suspended" class="tsd-kind-icon">suspended</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#updateHandler" class="tsd-kind-icon">update<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#updateOnPan" class="tsd-kind-icon">update<wbr/>On<wbr/>Pan</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="Outline.html#zoom" class="tsd-kind-icon">zoom</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#createGraph" class="tsd-kind-icon">create<wbr/>Graph</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#createSizer" class="tsd-kind-icon">create<wbr/>Sizer</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#getOutlineOffset" class="tsd-kind-icon">get<wbr/>Outline<wbr/>Offset</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#getSourceContainerSize" class="tsd-kind-icon">get<wbr/>Source<wbr/>Container<wbr/>Size</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#getSourceGraphBounds" class="tsd-kind-icon">get<wbr/>Source<wbr/>Graph<wbr/>Bounds</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#getTranslateForEvent" class="tsd-kind-icon">get<wbr/>Translate<wbr/>For<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#init" class="tsd-kind-icon">init</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#isEnabled" class="tsd-kind-icon">is<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#mouseDown" class="tsd-kind-icon">mouse<wbr/>Down</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#mouseMove" class="tsd-kind-icon">mouse<wbr/>Move</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#mouseUp" class="tsd-kind-icon">mouse<wbr/>Up</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#refresh" class="tsd-kind-icon">refresh</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#setEnabled" class="tsd-kind-icon">set<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#setZoomEnabled" class="tsd-kind-icon">set<wbr/>Zoom<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Outline.html#update" class="tsd-kind-icon">update</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |