64 lines
43 KiB
HTML
64 lines
43 KiB
HTML
|
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TooltipHandler | @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="TooltipHandler.html">TooltipHandler</a></li></ul><h1>Class TooltipHandler</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>Graph event handler that displays tooltips. {@link Graph#getTooltip} is used to
|
||
|
|
get the tooltip for a cell or handle. This handler is built-into
|
||
|
|
{@link Graph#tooltipHandler} and enabled using {@link Graph#setTooltips}.</p>
|
||
|
|
</div><div><p>Example:</p>
|
||
|
|
<p>(code>
|
||
|
|
new mxTooltipHandler(graph);
|
||
|
|
(end)</p>
|
||
|
|
<p>Constructor: mxTooltipHandler</p>
|
||
|
|
<p>Constructs an event handler that displays tooltips with the specified
|
||
|
|
delay (in milliseconds). If no delay is specified then a default delay
|
||
|
|
of 500 ms (0.5 sec) is used.</p>
|
||
|
|
</div><dl class="tsd-comment-tags"><dt>param graph</dt><dd><p>Reference to the enclosing <a href="Graph.html">Graph</a>.</p>
|
||
|
|
</dd><dt>param delay</dt><dd><p>Optional delay in milliseconds.</p>
|
||
|
|
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">TooltipHandler</span></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">GraphPlugin</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="TooltipHandler.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="TooltipHandler.html#delay" class="tsd-kind-icon">delay</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#destroyed" class="tsd-kind-icon">destroyed</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#div" class="tsd-kind-icon">div</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#graph" class="tsd-kind-icon">graph</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#hideOnHover" class="tsd-kind-icon">hide<wbr/>On<wbr/>Hover</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#ignoreTouchEvents" class="tsd-kind-icon">ignore<wbr/>Touch<wbr/>Events</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#lastX" class="tsd-kind-icon">lastX</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#lastY" class="tsd-kind-icon">lastY</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#node" class="tsd-kind-icon">node</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#state" class="tsd-kind-icon">state</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#stateSource" class="tsd-kind-icon">state<wbr/>Source</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#thread" class="tsd-kind-icon">thread</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#zIndex" class="tsd-kind-icon">z<wbr/>Index</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="TooltipHandler.html#pluginId" class="tsd-kind-icon">plugin<wbr/>Id</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="TooltipHandler.html#getStateForEvent" class="tsd-kind-icon">get<wbr/>State<wbr/>For<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="TooltipHandler.html#hide" class="tsd-kind-icon">hide</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="TooltipHandler.html#hideTooltip" class="tsd-kind-icon">hide<wbr/>Tooltip</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="TooltipHandler.html#isEnabled" class="tsd-kind-icon">is<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="TooltipHandler.html#isHideOnHover" class="tsd-kind-icon">is<wbr/>Hide<wbr/>On<wbr/>Hover</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="TooltipHandler.html#mouseDown" class="tsd-kind-icon">mouse<wbr/>Down</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="TooltipHandler.html#mouseMove" class="tsd-kind-icon">mouse<wbr/>Move</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="TooltipHandler.html#mouseUp" class="tsd-kind-icon">mouse<wbr/>Up</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="TooltipHandler.html#onDestroy" class="tsd-kind-icon">on<wbr/>De
|
||
|
|
<p>Delay to show the tooltip in milliseconds. Default is 500.</p>
|
||
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="destroyed" class="tsd-anchor"></a><h3>destroyed</h3><div class="tsd-signature tsd-kind-icon">destroyed<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/handler/TooltipHandler.ts#L106">view/handler/TooltipHandler.ts:106</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>True if this handler was destroyed using <destroy>.</p>
|
||
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="div" class="tsd-anchor"></a><h3>div</h3><div class="tsd-signature tsd-kind-icon">div<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLElement</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/TooltipHandler.ts#L75">view/handler/TooltipHandler.ts:75</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"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/TooltipHandler.ts#L118">view/handler/TooltipHandler.ts:118</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Specifies if events are handled. Default is false.</p>
|
||
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="graph" class="tsd-anchor"></a><h3>graph</h3><div class="tsd-signature tsd-kind-icon">graph<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/handler/TooltipHandler.ts#L85">view/handler/TooltipHandler.ts:85</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Reference to the enclosing <a href="Graph.html">Graph</a>.</p>
|
||
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="hideOnHover" class="tsd-anchor"></a><h3>hide<wbr/>On<wbr/>Hover</h3><div class="tsd-signature tsd-kind-icon">hide<wbr/>On<wbr/>Hover<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/handler/TooltipHandler.ts#L101">view/handler/TooltipHandler.ts:101</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Specifies if the tooltip should be hidden if the mouse is moved over the
|
||
|
|
current cell. Default is false.</p>
|
||
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="ignoreTouchEvents" class="tsd-anchor"></a><h3>ignore<wbr/>Touch<wbr/>Events</h3><div class="tsd-signature tsd-kind-icon">ignore<wbr/>Touch<wbr/>Events<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/handler/TooltipHandler.ts#L95">view/handler/TooltipHandler.ts:95</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Specifies if touch and pen events should be ignored. Default is true.</p>
|
||
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="lastX" class="tsd-anchor"></a><h3>lastX</h3><div class="tsd-signature tsd-kind-icon">lastX<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/TooltipHandler.ts#L108">view/handler/TooltipHandler.ts:108</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="lastY" class="tsd-anchor"></a><h3>lastY</h3><div class="tsd-signature tsd-kind-icon">lastY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/TooltipHandler.ts#L109">view/handler/TooltipHandler.ts:109</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="node" class="tsd-anchor"></a><h3>node</h3><div class="tsd-signature tsd-kind-icon">node<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/TooltipHandler.ts#L112">view/handler/TooltipHandler.ts:112</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="state" class="tsd-anchor"></a><h3>state</h3><div class="tsd-signature tsd-kind-icon">state<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</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/handler/TooltipHandler.ts#L110">view/handler/TooltipHandler.ts:110</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="stateSource" class="tsd-anchor"></a><h3>state<wbr/>Source</h3><div class="tsd-signature tsd-kind-icon">state<wbr/>Source<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/handler/TooltipHandler.ts#L111">view/handler/TooltipHandler.ts:111</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="thread" class="tsd-anchor"></a><h3>thread</h3><div class="tsd-signature tsd-kind-icon">thread<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/handler/TooltipHandler.ts#L113">view/handler/TooltipHandler.ts:113</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="zIndex" class="tsd-anchor"></a><h3>z<wbr/>Index</h3><div class="tsd-signature tsd-kind-icon">z<wbr/>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 10005</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/TooltipHandler.ts#L80">view/handler/TooltipHandler.ts:80</a></li></ul></aside><div class="tsd-comment tsd-typography">
|
||
|
|
<p>Specifies the zIndex for the tooltip and its shadow. Default is 10005.</p>
|
||
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"><a id="pluginId" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> plugin<wbr/>Id</h3><div class="tsd-signature tsd-kind-icon">plugin<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'TooltipHandler'</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/TooltipHandler.ts#L41">view/handler/TooltipHandler.ts:41</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="getStateForEvent" class="tsd-anchor"></a><h3>get<wbr/>State<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/>State<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><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</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/handler/TooltipHandler.ts#L153">view/handler/TooltipHandler.ts:153</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Returns the <CellState> to be used for showing a tooltip for this event.</p>
|
||
|
|
</div></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 <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="hide" class="tsd-anchor"></a><h3>hide</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">hide<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/handler/TooltipHandler.ts#L264">view/handler/TooltipHandler.ts:264</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Hides the tooltip and resets the timer.</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="hideTooltip" class="tsd-anchor"></a><h3>hide<wbr/>Tooltip</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">hide<wbr/>Tooltip<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/handler/TooltipHandler.ts#L272">view/handler/TooltipHandler.ts:272</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Hides the tooltip.</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="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/handler/TooltipHandler.ts#L124">view/handler/TooltipHandler.ts:124</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Returns true if events are handled. This implementation
|
||
|
|
returns <enabled>.</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="isHideOnHover" class="tsd-anchor"></a><h3>is<wbr/>Hide<wbr/>On<wbr/>Hover</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Hide<wbr/>On<wbr/>Hover<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/handler/TooltipHandler.ts#L139">view/handler/TooltipHandler.ts:139</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Returns <hideOnHover>.</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/handler/TooltipHandler.ts#L162">view/handler/TooltipHandler.ts:162</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Handles the event by initiating a rubberband selection. By consuming the
|
||
|
|
event all subsequent events of the gesture are redirected to this
|
||
|
|
handler.</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/handler/TooltipHandler.ts#L170">view/handler/TooltipHandler.ts:170</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Handles the event by updating the rubberband selection.</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/handler/TooltipHandler.ts#L196">view/handler/TooltipHandler.ts:196</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Handles the event by resetting the tooltip timer or hiding the existing
|
||
|
|
tooltip.</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="onDestroy" class="tsd-anchor"></a><h3>on<wbr/>Destroy</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">on<wbr/>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"><p>Implementation of GraphPlugin.onDestroy</p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/TooltipHandler.ts#L304">view/handler/TooltipHandler.ts:304</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Destroys the handler and all its resources and DOM nodes.</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="reset" class="tsd-anchor"></a><h3>reset</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">reset<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>, restart<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, state<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</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/handler/TooltipHandler.ts#L214">view/handler/TooltipHandler.ts:214</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Resets and/or restarts the timer to trigger the display of the tooltip.</p>
|
||
|
|
</div></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><li><h5>restart: <span class="tsd-signature-type">boolean</span></h5></li><li><h5>state: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a><span class="tsd-signature-symbol"> = null</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="resetTimer" class="tsd-anchor"></a><h3>reset<wbr/>Timer</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">reset<wbr/>Timer<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/handler/TooltipHandler.ts#L204">view/handler/TooltipHandler.ts:204</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Resets the timer.</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>enabled<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/handler/TooltipHandler.ts#L132">view/handler/TooltipHandler.ts:132</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Enables or disables event handling. This implementation
|
||
|
|
updates <enabled>.</p>
|
||
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>enabled: <span class="tsd-signature-type">boolean</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="setHideOnHover" class="tsd-anchor"></a><h3>set<wbr/>Hide<wbr/>On<wbr/>Hover</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Hide<wbr/>On<wbr/>Hover<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/handler/TooltipHandler.ts#L146">view/handler/TooltipHandler.ts:146</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Sets <hideOnHover>.</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></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="show" class="tsd-anchor"></a><h3>show</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">show<span class="tsd-signature-symbol">(</span>tip<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-type">HTMLElement</span>, x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<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">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/handler/TooltipHandler.ts#L281">view/handler/TooltipHandler.ts:281</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||
|
|
<p>Shows the tooltip for the specified cell and optional index at the
|
||
|
|
specified location (with a vertical offset of 10 pixels).</p>
|
||
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>tip: <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-type">HTMLElement</span></h5></li><li><h5>x: <span class="tsd-signature-type">number</span></h5></li><li><h5>y: <span class="tsd-signature-type">number</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="TooltipHandler.html" class="tsd-kind-icon">Tooltip<wbr/>Handler</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="TooltipHandler.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#delay" class="tsd-kind-icon">delay</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#destroyed" class="tsd-kind-icon">destroyed</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#div" class="tsd-kind-icon">div</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#graph" class="tsd-kind-icon">graph</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#hideOnHover" class="tsd-kind-icon">hide<wbr/>On<wbr/>Hover</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#ignoreTouchEvents" class="tsd-kind-icon">ignore<wbr/>Touch<wbr/>Events</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#lastX" class="tsd-kind-icon">lastX</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#lastY" class="tsd-kind-icon">lastY</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#node" class="tsd-kind-icon">node</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#state" class="tsd-kind-icon">state</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#stateSource" class="tsd-kind-icon">state<wbr/>Source</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#thread" class="tsd-kind-icon">thread</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="TooltipHandler.html#zIndex" class="tsd-kind-icon">z<wbr/>Index</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="TooltipHandler.html#pluginId" class="tsd-kind-icon">plugin<wbr/>Id</a></li><li class="tsd-kind-method tsd-par
|