zcy
/
maxGraph
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
maxGraph/docs/api/classes/EditorToolbar.html

134 lines
51 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EditorToolbar | @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="EditorToolbar.html">EditorToolbar</a></li></ul><h1>Class EditorToolbar</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Toolbar for the editor. This modifies the state of the graph
or inserts new cells upon mouse clicks.</p>
</div><dl class="tsd-comment-tags"><dt>example:</dt><dd><p>Create a toolbar with a button to copy the selection into the clipboard,
and a combo box with one action to paste the selection from the clipboard
into the graph.</p>
<pre><code><span class="hl-3">var</span><span class="hl-1"> </span><span class="hl-0">toolbar</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-2">EditorToolbar</span><span class="hl-1">(</span><span class="hl-0">container</span><span class="hl-1">, </span><span class="hl-0">editor</span><span class="hl-1">);</span><br/><span class="hl-0">toolbar</span><span class="hl-1">.</span><span class="hl-2">addItem</span><span class="hl-1">(</span><span class="hl-6">&#39;Copy&#39;</span><span class="hl-1">, </span><span class="hl-3">null</span><span class="hl-1">, </span><span class="hl-6">&#39;copy&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-3">var</span><span class="hl-1"> </span><span class="hl-0">combo</span><span class="hl-1"> = </span><span class="hl-0">toolbar</span><span class="hl-1">.</span><span class="hl-2">addActionCombo</span><span class="hl-1">(</span><span class="hl-6">&#39;More actions...&#39;</span><span class="hl-1">);</span><br/><span class="hl-0">toolbar</span><span class="hl-1">.</span><span class="hl-2">addActionOption</span><span class="hl-1">(</span><span class="hl-0">combo</span><span class="hl-1">, </span><span class="hl-6">&#39;Paste&#39;</span><span class="hl-1">, </span><span class="hl-6">&#39;paste&#39;</span><span class="hl-1">);</span>
</code></pre>
</dd><dt>codec:</dt><dd><p>This class uses the {@link DefaultToolbarCodec} to read configuration
data into an existing instance. See {@link DefaultToolbarCodec} for a
description of the configuration format.</p>
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">EditorToolbar</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="EditorToolbar.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="EditorToolbar.html#connectOnDrop" class="tsd-kind-icon">connect<wbr/>On<wbr/>Drop</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="EditorToolbar.html#editor" class="tsd-kind-icon">editor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="EditorToolbar.html#resetHandler" class="tsd-kind-icon">reset<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="EditorToolbar.html#spacing" class="tsd-kind-icon">spacing</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="EditorToolbar.html#toolbar" class="tsd-kind-icon">toolbar</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="EditorToolbar.html#addActionCombo" class="tsd-kind-icon">add<wbr/>Action<wbr/>Combo</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#addActionOption" class="tsd-kind-icon">add<wbr/>Action<wbr/>Option</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#addCombo" class="tsd-kind-icon">add<wbr/>Combo</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#addItem" class="tsd-kind-icon">add<wbr/>Item</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#addMode" class="tsd-kind-icon">add<wbr/>Mode</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#addOption" class="tsd-kind-icon">add<wbr/>Option</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#addPrototype" class="tsd-kind-icon">add<wbr/>Prototype</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#addSeparator" class="tsd-kind-icon">add<wbr/>Separator</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#connect" class="tsd-kind-icon">connect</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#drop" class="tsd-kind-icon">drop</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#init" class="tsd-kind-icon">init</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#insert" class="tsd-kind-icon">insert</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#installDropHandler" class="tsd-kind-icon">install<wbr/>Drop<wbr/>Handler</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/>Editor<wbr/>Toolbar<span class="tsd-signature-symbol">(</span>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>, editor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Editor.html" class="tsd-signature-type" data-tsd-kind="Class">Editor</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="EditorToolbar.html" class="tsd-signature-type" data-tsd-kind="Class">EditorToolbar</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/editor/EditorToolbar.ts#L54">editor/EditorToolbar.ts:54</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><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><li><h5>editor: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Editor.html" class="tsd-signature-type" data-tsd-kind="Class">Editor</a><span class="tsd-signature-symbol"> = null</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="EditorToolbar.html" class="tsd-signature-type" data-tsd-kind="Class">EditorToolbar</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="connectOnDrop" class="tsd-anchor"></a><h3>connect<wbr/>On<wbr/>Drop</h3><div class="tsd-signature tsd-kind-icon">connect<wbr/>On<wbr/>Drop<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/editor/EditorToolbar.ts#L89">editor/EditorToolbar.ts:89</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Specifies if elements should be connected if new cells are dropped onto connectable elements.</p>
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>is false.</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="editor" class="tsd-anchor"></a><h3>editor</h3><div class="tsd-signature tsd-kind-icon">editor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Editor.html" class="tsd-signature-type" data-tsd-kind="Class">Editor</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/editor/EditorToolbar.ts#L65">editor/EditorToolbar.ts:65</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Reference to the enclosing <a href="Editor.html">Editor</a>.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="resetHandler" class="tsd-anchor"></a><h3>reset<wbr/>Handler</h3><div class="tsd-signature tsd-kind-icon">reset<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-type">Function</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/editor/EditorToolbar.ts#L75">editor/EditorToolbar.ts:75</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Reference to the function used to reset the <a href="EditorToolbar.html#toolbar">toolbar</a>.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="spacing" class="tsd-anchor"></a><h3>spacing</h3><div class="tsd-signature tsd-kind-icon">spacing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 4</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/editor/EditorToolbar.ts#L82">editor/EditorToolbar.ts:82</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Defines the spacing between existing and new vertices in gridSize units when a new vertex is dropped on an existing cell. Default is 4 (40 pixels).</p>
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>is 4</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="toolbar" class="tsd-anchor"></a><h3>toolbar</h3><div class="tsd-signature tsd-kind-icon">toolbar<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="MaxToolbar.html" class="tsd-signature-type" data-tsd-kind="Class">MaxToolbar</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/editor/EditorToolbar.ts#L70">editor/EditorToolbar.ts:70</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Holds the internal <a href="MaxToolbar.html">MaxToolbar</a>.</p>
</div></div></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="addActionCombo" class="tsd-anchor"></a><h3>add<wbr/>Action<wbr/>Combo</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Action<wbr/>Combo<span class="tsd-signature-symbol">(</span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLSelectElement</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/editor/EditorToolbar.ts#L166">editor/EditorToolbar.ts:166</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Helper method to invoke &lt;MaxToolbar.addActionCombo&gt; on <toolbar> using
the given title and return the resulting DOM node.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>title: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>String that represents the title of the combo.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLSelectElement</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addActionOption" class="tsd-anchor"></a><h3>add<wbr/>Action<wbr/>Option</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Action<wbr/>Option<span class="tsd-signature-symbol">(</span>combo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLSelectElement</span>, title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, action<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">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/editor/EditorToolbar.ts#L177">editor/EditorToolbar.ts:177</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Binds the given action to a option with the specified label in the given combo. Combo is an object returned from an earlier call to <a href="EditorToolbar.html#addCombo">addCombo</a> or <a href="EditorToolbar.html#addActionCombo">addActionCombo</a>.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>combo: <span class="tsd-signature-type">HTMLSelectElement</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>DOM node that represents the combo box.</p>
</div></div></li><li><h5>title: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>String that represents the title of the combo.</p>
</div></div></li><li><h5>action: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Name of the action to execute in <a href="EditorToolbar.html#editor">editor</a>.</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="addCombo" class="tsd-anchor"></a><h3>add<wbr/>Combo</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Combo<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</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/editor/EditorToolbar.ts#L156">editor/EditorToolbar.ts:156</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Helper method to invoke <a href="MaxToolbar.html#addCombo">MaxToolbar.addCombo</a> on toolbar and return the resulting DOM node.</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLElement</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addItem" class="tsd-anchor"></a><h3>add<wbr/>Item</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Item<span class="tsd-signature-symbol">(</span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, icon<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, action<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, pressed<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/editor/EditorToolbar.ts#L134">editor/EditorToolbar.ts:134</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Adds a new item that executes the given action in <a href="EditorToolbar.html#editor">editor</a>. The title,
icon and pressedIcon are used to display the toolbar item.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>title: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>String that represents the title (tooltip) for the item.</p>
</div></div></li><li><h5>icon: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>URL of the icon to be used for displaying the item.</p>
</div></div></li><li><h5>action: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Name of the action to execute when the item is clicked.</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> pressed: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional URL of the icon for the pressed state.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addMode" class="tsd-anchor"></a><h3>add<wbr/>Mode</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Mode<span class="tsd-signature-symbol">(</span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, icon<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, mode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, pressed<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, funct<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/editor/EditorToolbar.ts#L206">editor/EditorToolbar.ts:206</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Creates an item for selecting the given mode in the <a href="EditorToolbar.html#editor">editor</a>&#39;s graph.
Supported modenames are select, connect and pan.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>title: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>String that represents the title of the item.</p>
</div></div></li><li><h5>icon: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>URL of the icon that represents the item.</p>
</div></div></li><li><h5>mode: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>String that represents the mode name to be used in <a href="Editor.html#setMode">Editor.setMode</a>.</p>
</div></div></li><li><h5>pressed: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional URL of the icon that represents the pressed state.</p>
</div></div></li><li><h5>funct: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional JavaScript function that takes the <a href="Editor.html">Editor</a> as the first and only argument that is executed after the mode has been selected.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addOption" class="tsd-anchor"></a><h3>add<wbr/>Option</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Option<span class="tsd-signature-symbol">(</span>combo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLSelectElement</span>, title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>evt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</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/editor/EditorToolbar.ts#L192">editor/EditorToolbar.ts:192</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Helper method to invoke <a href="MaxToolbar.html#addOption">MaxToolbar.addOption</a> on <a href="EditorToolbar.html#toolbar">toolbar</a> and return the resulting DOM node that represents the option.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>combo: <span class="tsd-signature-type">HTMLSelectElement</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>DOM node that represents the combo box.</p>
</div></div></li><li><h5>title: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>String that represents the title of the combo.</p>
</div></div></li><li><h5>value: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>evt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Object that represents the value of the option.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLElement</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addPrototype" class="tsd-anchor"></a><h3>add<wbr/>Prototype</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Prototype<span class="tsd-signature-symbol">(</span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, icon<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, ptype<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, pressed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, insert<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>editor<span class="tsd-signature-symbol">: </span><a href="Editor.html" class="tsd-signature-type" data-tsd-kind="Class">Editor</a>, cell<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, me<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MouseEvent</span>, cellUnderMousePointer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span>, toggle<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">HTMLImageElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLButtonElement</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/editor/EditorToolbar.ts#L240">editor/EditorToolbar.ts:240</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Creates an item for inserting a clone of the specified prototype cell into
the <editor>&#39;s graph. The ptype may either be a cell or a function that
returns a cell.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>title: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>String that represents the title of the item.</p>
</div></div></li><li><h5>icon: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>URL of the icon that represents the item.</p>
</div></div></li><li><h5>ptype: <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Function or object that represents the prototype cell. If ptype
is a function then it is invoked with no arguments to create new
instances.</p>
</div></div></li><li><h5>pressed: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional URL of the icon that represents the pressed state.</p>
</div></div></li><li><h5>insert: <span class="tsd-signature-symbol">(</span>editor<span class="tsd-signature-symbol">: </span><a href="Editor.html" class="tsd-signature-type" data-tsd-kind="Class">Editor</a>, cell<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, me<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MouseEvent</span>, cellUnderMousePointer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional JavaScript function that handles an insert of the new
cell. This function takes the <Editor>, new cell to be inserted, mouse
event and optional <Cell> under the mouse pointer as arguments.</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>editor<span class="tsd-signature-symbol">: </span><a href="Editor.html" class="tsd-signature-type" data-tsd-kind="Class">Editor</a>, cell<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, me<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MouseEvent</span>, cellUnderMousePointer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</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"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>editor: <a href="Editor.html" class="tsd-signature-type" data-tsd-kind="Class">Editor</a></h5></li><li><h5>cell: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5></li><li><h5>me: <span class="tsd-signature-type">MouseEvent</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> cellUnderMousePointer: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li><h5>toggle: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional boolean that specifies if the item can be toggled.
Default is true.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLImageElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLButtonElement</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addSeparator" class="tsd-anchor"></a><h3>add<wbr/>Separator</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">add<wbr/>Separator<span class="tsd-signature-symbol">(</span>icon<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">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/editor/EditorToolbar.ts#L148">editor/EditorToolbar.ts:148</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Adds a vertical separator using the optional icon.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> icon: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional URL of the icon that represents the vertical separator. Default is <a href="Client.html#imageBasePath">Client.imageBasePath</a> + ‘/separator.gif’.</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="connect" class="tsd-anchor"></a><h3>connect</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">connect<span class="tsd-signature-symbol">(</span>vertex<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, evt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MouseEvent</span>, source<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</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/editor/EditorToolbar.ts#L345">editor/EditorToolbar.ts:345</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Handles a drop by connecting the given vertex to the given source cell.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>vertex: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p><a href="Cell.html">Cell</a> to be inserted.</p>
</div></div></li><li><h5>evt: <span class="tsd-signature-type">MouseEvent</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Mouse event that represents the drop.</p>
</div></div></li><li><h5>source: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional <a href="Cell.html">Cell</a> that represents the source terminal.</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="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/editor/EditorToolbar.ts#L433">editor/EditorToolbar.ts:433</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Destroys the <a href="EditorToolbar.html#toolbar">toolbar</a> associated with this object and removes all installed listeners.
This does normally not need to be called, the <a href="EditorToolbar.html#toolbar">toolbar</a> is destroyed automatically when the window unloads (in IE) by <a href="Editor.html">Editor</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="drop" class="tsd-anchor"></a><h3>drop</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">drop<span class="tsd-signature-symbol">(</span>vertex<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, evt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MouseEvent</span>, target<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</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/editor/EditorToolbar.ts#L294">editor/EditorToolbar.ts:294</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Handles a drop from a toolbar item to the graph. The given vertex
represents the new cell to be inserted. This invokes <a href="EditorToolbar.html#insert">insert</a> or
<a href="EditorToolbar.html#connect">connect</a> depending on the given target cell.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>vertex: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p><a href="Cell.html">Cell</a> to be inserted.</p>
</div></div></li><li><h5>evt: <span class="tsd-signature-type">MouseEvent</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Mouse event that represents the drop.</p>
</div></div></li><li><h5>target: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional <a href="Cell.html">Cell</a> that represents the drop target.</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="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/editor/EditorToolbar.ts#L94">editor/EditorToolbar.ts:94</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Constructs the <a href="EditorToolbar.html#toolbar">toolbar</a> for the given container and installs a listener that updates the <a href="Editor.html#insertFunction">Editor.insertFunction</a> on <a href="EditorToolbar.html#editor">editor</a> if an item is selected in the toolbar. This assumes that <a href="EditorToolbar.html#editor">editor</a> is not null.</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="insert" class="tsd-anchor"></a><h3>insert</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">insert<span class="tsd-signature-symbol">(</span>vertex<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, evt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MouseEvent</span>, target<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/editor/EditorToolbar.ts#L321">editor/EditorToolbar.ts:321</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Handles a drop by inserting the given vertex into the given parent cell
or the default parent if no parent is specified.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>vertex: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p><a href="Cell.html">Cell</a> to be inserted.</p>
</div></div></li><li><h5>evt: <span class="tsd-signature-type">MouseEvent</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Mouse event that represents the drop.</p>
</div></div></li><li><h5>target: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional <a href="Cell.html">Cell</a> that represents the parent.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="installDropHandler" class="tsd-anchor"></a><h3>install<wbr/>Drop<wbr/>Handler</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">install<wbr/>Drop<wbr/>Handler<span class="tsd-signature-symbol">(</span>img<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span>, dropHandler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DropHandler</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/editor/EditorToolbar.ts#L410">editor/EditorToolbar.ts:410</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Makes the given img draggable using the given function for handling a drop event.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>img: <span class="tsd-signature-type">HTMLElement</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>DOM node that represents the image.</p>
</div></div></li><li><h5>dropHandler: <span class="tsd-signature-type">DropHandler</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Function that handles a drop of the image.</p>
</div></div></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="EditorToolbar.html" class="tsd-kind-icon">Editor<wbr/>Toolbar</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="EditorToolbar.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="EditorToolbar.html#connectOnDrop" class="tsd-kind-icon">connect<wbr/>On<wbr/>Drop</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="EditorToolbar.html#editor" class="tsd-kind-icon">editor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="EditorToolbar.html#resetHandler" class="tsd-kind-icon">reset<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="EditorToolbar.html#spacing" class="tsd-kind-icon">spacing</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="EditorToolbar.html#toolbar" class="tsd-kind-icon">toolbar</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#addActionCombo" class="tsd-kind-icon">add<wbr/>Action<wbr/>Combo</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#addActionOption" class="tsd-kind-icon">add<wbr/>Action<wbr/>Option</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#addCombo" class="tsd-kind-icon">add<wbr/>Combo</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#addItem" class="tsd-kind-icon">add<wbr/>Item</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#addMode" class="tsd-kind-icon">add<wbr/>Mode</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#addOption" class="tsd-kind-icon">add<wbr/>Option</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#addPrototype" class="tsd-kind-icon">add<wbr/>Prototype</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#addSeparator" class="tsd-kind-icon">add<wbr/>Separator</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#connect" class="tsd-kind-icon">connect</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#drop" class="tsd-kind-icon">drop</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#init" class="tsd-kind-icon">init</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#insert" class="tsd-kind-icon">insert</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EditorToolbar.html#installDropHandler" class="tsd-kind-icon">install<wbr/>Drop<wbr/>Handler</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>
Reference in New Issue View Git Blame Copy Permalink