maxGraph/docs/api/classes/KeyHandler.html

126 lines
46 KiB
HTML

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>KeyHandler | @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="KeyHandler.html">KeyHandler</a></li></ul><h1>Class KeyHandler</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>Event handler that listens to keystroke events. This is not a singleton,
however, it is normally only required once if the target is the document
element (default).</p>
</div><div><p>This handler installs a key event listener in the topmost DOM node and
processes all events that originate from descandants of {@link Graph#container}
or from the topmost DOM node. The latter means that all unhandled keystrokes
are handled by this object regardless of the focused state of the <graph>.</p>
<p>Example:</p>
<p>The following example creates a key handler that listens to the delete key
(46) and deletes the selection cells if the graph is enabled.</p>
<pre><code class="language-javascript"><span class="hl-3">let</span><span class="hl-1"> </span><span class="hl-0">keyHandler</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-2">KeyHandler</span><span class="hl-1">(</span><span class="hl-0">graph</span><span class="hl-1">);</span><br/><span class="hl-0">keyHandler</span><span class="hl-1">.</span><span class="hl-2">bindKey</span><span class="hl-1">(</span><span class="hl-8">46</span><span class="hl-1">, (</span><span class="hl-0">evt</span><span class="hl-1">)</span><span class="hl-3">=&gt;</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1"> (</span><span class="hl-0">graph</span><span class="hl-1">.</span><span class="hl-2">isEnabled</span><span class="hl-1">())</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">graph</span><span class="hl-1">.</span><span class="hl-2">removeCells</span><span class="hl-1">();</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
</code></pre>
<p>Keycodes:</p>
<p>See <a href="http://tinyurl.com/yp8jgl">http://tinyurl.com/yp8jgl</a> or <a href="http://tinyurl.com/229yqw">http://tinyurl.com/229yqw</a> for a list of
keycodes or install a key event listener into the document element and print
the key codes of the respective events to the console.</p>
<p>To support the Command key and the Control key on the Mac, the following
code can be used.</p>
<pre><code class="language-javascript"><span class="hl-0">keyHandler</span><span class="hl-1">.</span><span class="hl-2">getFunction</span><span class="hl-1"> = (</span><span class="hl-0">evt</span><span class="hl-1">)</span><span class="hl-3">=&gt;</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1"> (</span><span class="hl-0">evt</span><span class="hl-1"> != </span><span class="hl-3">null</span><span class="hl-1">)</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-5">return</span><span class="hl-1"> (</span><span class="hl-0">mxEvent</span><span class="hl-1">.</span><span class="hl-2">isControlDown</span><span class="hl-1">(</span><span class="hl-0">evt</span><span class="hl-1">) || (</span><span class="hl-0">Client</span><span class="hl-1">.</span><span class="hl-7">IS_MAC</span><span class="hl-1"> &amp;&amp; </span><span class="hl-0">evt</span><span class="hl-1">.</span><span class="hl-0">metaKey</span><span class="hl-1">)) ? </span><span class="hl-3">this</span><span class="hl-1">.</span><span class="hl-0">controlKeys</span><span class="hl-1">[</span><span class="hl-0">evt</span><span class="hl-1">.</span><span class="hl-0">keyCode</span><span class="hl-1">] : </span><span class="hl-3">this</span><span class="hl-1">.</span><span class="hl-0">normalKeys</span><span class="hl-1">[</span><span class="hl-0">evt</span><span class="hl-1">.</span><span class="hl-0">keyCode</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-3">null</span><span class="hl-1">;</span><br/><span class="hl-1">};</span>
</code></pre>
<p>Constructor: KeyHandler</p>
<p>Constructs an event handler that executes functions bound to specific
keystrokes.</p>
</div><dl class="tsd-comment-tags"><dt>param graph</dt><dd><p>Reference to the associated <a href="Graph.html">Graph</a>.</p>
</dd><dt>param target</dt><dd><p>Optional reference to the event target. If null, the document
element is used as the event target, that is, the object where the key
event listener is installed.</p>
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">KeyHandler</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="KeyHandler.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="KeyHandler.html#controlKeys" class="tsd-kind-icon">control<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="KeyHandler.html#controlShiftKeys" class="tsd-kind-icon">control<wbr/>Shift<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="KeyHandler.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="KeyHandler.html#graph" class="tsd-kind-icon">graph</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="KeyHandler.html#keydownHandler" class="tsd-kind-icon">keydown<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="KeyHandler.html#normalKeys" class="tsd-kind-icon">normal<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="KeyHandler.html#shiftKeys" class="tsd-kind-icon">shift<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="KeyHandler.html#target" class="tsd-kind-icon">target</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="KeyHandler.html#bindControlKey" class="tsd-kind-icon">bind<wbr/>Control<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#bindControlShiftKey" class="tsd-kind-icon">bind<wbr/>Control<wbr/>Shift<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#bindKey" class="tsd-kind-icon">bind<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#bindShiftKey" class="tsd-kind-icon">bind<wbr/>Shift<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#escape" class="tsd-kind-icon">escape</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#getFunction" class="tsd-kind-icon">get<wbr/>Function</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#isControlDown" class="tsd-kind-icon">is<wbr/>Control<wbr/>Down</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#isEnabled" class="tsd-kind-icon">is<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#isEnabledForEvent" class="tsd-kind-icon">is<wbr/>Enabled<wbr/>For<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#isEventIgnored" class="tsd-kind-icon">is<wbr/>Event<wbr/>Ignored</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#isGraphEvent" class="tsd-kind-icon">is<wbr/>Graph<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#keyDown" class="tsd-kind-icon">key<wbr/>Down</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#onDestroy" class="tsd-kind-icon">on<wbr/>Destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#setEnabled" class="tsd-kind-icon">set<wbr/>Enabled</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/>Key<wbr/>Handler<span class="tsd-signature-symbol">(</span>graph<span class="tsd-signature-symbol">: </span><a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a>, target<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="KeyHandler.html" class="tsd-signature-type" data-tsd-kind="Class">KeyHandler</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/KeyHandler.ts#L72">view/handler/KeyHandler.ts:72</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>graph: <a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a></h5></li><li><h5>target: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol"> = null</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="KeyHandler.html" class="tsd-signature-type" data-tsd-kind="Class">KeyHandler</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="controlKeys" class="tsd-anchor"></a><h3>control<wbr/>Keys</h3><div class="tsd-signature tsd-kind-icon">control<wbr/>Keys<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/KeyHandler.ts#L112">view/handler/KeyHandler.ts:112</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Maps from keycodes to functions for pressed control keys.</p>
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">Function</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="controlShiftKeys" class="tsd-anchor"></a><h3>control<wbr/>Shift<wbr/>Keys</h3><div class="tsd-signature tsd-kind-icon">control<wbr/>Shift<wbr/>Keys<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/KeyHandler.ts#L117">view/handler/KeyHandler.ts:117</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Maps from keycodes to functions for pressed control and shift keys.</p>
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">Function</span></h5></li></ul></div></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/handler/KeyHandler.ts#L122">view/handler/KeyHandler.ts:122</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Specifies if events are handled. Default is true.</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> <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/handler/KeyHandler.ts#L91">view/handler/KeyHandler.ts:91</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Reference to the <a href="Graph.html">Graph</a> associated with this handler.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="keydownHandler" class="tsd-anchor"></a><h3>keydown<wbr/>Handler</h3><div class="tsd-signature tsd-kind-icon">keydown<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>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">KeyboardEvent</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"> = 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/KeyHandler.ts#L86">view/handler/KeyHandler.ts:86</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="normalKeys" class="tsd-anchor"></a><h3>normal<wbr/>Keys</h3><div class="tsd-signature tsd-kind-icon">normal<wbr/>Keys<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/KeyHandler.ts#L102">view/handler/KeyHandler.ts:102</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Maps from keycodes to functions for non-pressed control keys.</p>
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">Function</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="shiftKeys" class="tsd-anchor"></a><h3>shift<wbr/>Keys</h3><div class="tsd-signature tsd-kind-icon">shift<wbr/>Keys<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/KeyHandler.ts#L107">view/handler/KeyHandler.ts:107</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Maps from keycodes to functions for pressed shift keys.</p>
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">Function</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="target" class="tsd-anchor"></a><h3>target</h3><div class="tsd-signature tsd-kind-icon">target<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</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/KeyHandler.ts#L97">view/handler/KeyHandler.ts:97</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Reference to the target DOM, that is, the DOM node where the key event
listeners are installed.</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="bindControlKey" class="tsd-anchor"></a><h3>bind<wbr/>Control<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">bind<wbr/>Control<wbr/>Key<span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, funct<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">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/KeyHandler.ts#L170">view/handler/KeyHandler.ts:170</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Binds the specified keycode to the given function. This binding is used
if the control key is pressed.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>code: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Integer that specifies the keycode.</p>
</div></div></li><li><h5>funct: <span class="tsd-signature-type">Function</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>JavaScript function that takes the key event as an argument.</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="bindControlShiftKey" class="tsd-anchor"></a><h3>bind<wbr/>Control<wbr/>Shift<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">bind<wbr/>Control<wbr/>Shift<wbr/>Key<span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, funct<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">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/KeyHandler.ts#L181">view/handler/KeyHandler.ts:181</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Binds the specified keycode to the given function. This binding is used
if the control and shift key are pressed.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>code: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Integer that specifies the keycode.</p>
</div></div></li><li><h5>funct: <span class="tsd-signature-type">Function</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>JavaScript function that takes the key event as an argument.</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="bindKey" class="tsd-anchor"></a><h3>bind<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">bind<wbr/>Key<span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, funct<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">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/KeyHandler.ts#L148">view/handler/KeyHandler.ts:148</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Binds the specified keycode to the given function. This binding is used
if the control key is not pressed.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>code: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Integer that specifies the keycode.</p>
</div></div></li><li><h5>funct: <span class="tsd-signature-type">Function</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>JavaScript function that takes the key event as an argument.</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="bindShiftKey" class="tsd-anchor"></a><h3>bind<wbr/>Shift<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">bind<wbr/>Shift<wbr/>Key<span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, funct<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">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/KeyHandler.ts#L159">view/handler/KeyHandler.ts:159</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Binds the specified keycode to the given function. This binding is used
if the shift key is pressed.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>code: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Integer that specifies the keycode.</p>
</div></div></li><li><h5>funct: <span class="tsd-signature-type">Function</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>JavaScript function that takes the key event as an argument.</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="escape" class="tsd-anchor"></a><h3>escape</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">escape<span class="tsd-signature-symbol">(</span>evt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">KeyboardEvent</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/KeyHandler.ts#L307">view/handler/KeyHandler.ts:307</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Hook to process ESCAPE keystrokes. This implementation invokes
{@link Graph#stopEditing} to cancel the current editing, connecting
and/or other ongoing modifications.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>evt: <span class="tsd-signature-type">KeyboardEvent</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Key event that represents the keystroke. Possible keycode in this
case is 27 (ESCAPE).</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="getFunction" class="tsd-anchor"></a><h3>get<wbr/>Function</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Function<span class="tsd-signature-symbol">(</span>evt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">KeyboardEvent</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><span class="tsd-signature-type">Function</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/KeyHandler.ts#L200">view/handler/KeyHandler.ts:200</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns the function associated with the given key event or null if no
function is associated with the given event.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>evt: <span class="tsd-signature-type">KeyboardEvent</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Key event whose associated function should be returned.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Function</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isControlDown" class="tsd-anchor"></a><h3>is<wbr/>Control<wbr/>Down</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Control<wbr/>Down<span class="tsd-signature-symbol">(</span>evt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">KeyboardEvent</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/KeyHandler.ts#L190">view/handler/KeyHandler.ts:190</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns true if the control key is pressed. This uses {@link Event#isControlDown}.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>evt: <span class="tsd-signature-type">KeyboardEvent</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Key event whose control key pressed state should be returned.</p>
</div></div></li></ul><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="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/KeyHandler.ts#L128">view/handler/KeyHandler.ts:128</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="isEnabledForEvent" class="tsd-anchor"></a><h3>is<wbr/>Enabled<wbr/>For<wbr/>Event</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Enabled<wbr/>For<wbr/>Event<span class="tsd-signature-symbol">(</span>evt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">KeyboardEvent</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/KeyHandler.ts#L280">view/handler/KeyHandler.ts:280</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns true if the given event should be handled. <isEventIgnored> is
called later if the event is not an escape key stroke, in which case
<escape> is called. This implementation returns true if <isEnabled>
returns true for both, this handler and <graph>, if the event is not
consumed and if <isGraphEvent> returns true.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>evt: <span class="tsd-signature-type">KeyboardEvent</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Key event that represents the keystroke.</p>
</div></div></li></ul><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="isEventIgnored" class="tsd-anchor"></a><h3>is<wbr/>Event<wbr/>Ignored</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Event<wbr/>Ignored<span class="tsd-signature-symbol">(</span>evt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">KeyboardEvent</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/KeyHandler.ts#L295">view/handler/KeyHandler.ts:295</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns true if the given keystroke should be ignored. This returns
graph.isEditing().</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>evt: <span class="tsd-signature-type">KeyboardEvent</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Key event that represents the keystroke.</p>
</div></div></li></ul><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="isGraphEvent" class="tsd-anchor"></a><h3>is<wbr/>Graph<wbr/>Event</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Graph<wbr/>Event<span class="tsd-signature-symbol">(</span>evt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">KeyboardEvent</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/KeyHandler.ts#L225">view/handler/KeyHandler.ts:225</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns true if the event should be processed by this handler, that is,
if the event source is either the target, one of its direct children, a
descendant of the {@link Graph#container}, or the {@link Graph#cellEditor} of the
<graph>.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>evt: <span class="tsd-signature-type">KeyboardEvent</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Key event that represents the keystroke.</p>
</div></div></li></ul><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="keyDown" class="tsd-anchor"></a><h3>key<wbr/>Down</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">key<wbr/>Down<span class="tsd-signature-symbol">(</span>evt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">KeyboardEvent</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/KeyHandler.ts#L252">view/handler/KeyHandler.ts:252</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Handles the event by invoking the function bound to the respective keystroke
if <isEnabledForEvent> returns true for the given event and if
<isEventIgnored> returns false, except for escape for which
<isEventIgnored> is not invoked.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>evt: <span class="tsd-signature-type">KeyboardEvent</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Key event that represents the keystroke.</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="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"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/KeyHandler.ts#L318">view/handler/KeyHandler.ts:318</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Destroys the handler and all its references into the DOM. This does
normally not need to be called, it is called automatically when the
window unloads (in IE).</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/KeyHandler.ts#L137">view/handler/KeyHandler.ts:137</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Enables or disables event handling by updating <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><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></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="KeyHandler.html" class="tsd-kind-icon">Key<wbr/>Handler</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="KeyHandler.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="KeyHandler.html#controlKeys" class="tsd-kind-icon">control<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="KeyHandler.html#controlShiftKeys" class="tsd-kind-icon">control<wbr/>Shift<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="KeyHandler.html#enabled" class="tsd-kind-icon">enabled</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="KeyHandler.html#graph" class="tsd-kind-icon">graph</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="KeyHandler.html#keydownHandler" class="tsd-kind-icon">keydown<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="KeyHandler.html#normalKeys" class="tsd-kind-icon">normal<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="KeyHandler.html#shiftKeys" class="tsd-kind-icon">shift<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="KeyHandler.html#target" class="tsd-kind-icon">target</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#bindControlKey" class="tsd-kind-icon">bind<wbr/>Control<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#bindControlShiftKey" class="tsd-kind-icon">bind<wbr/>Control<wbr/>Shift<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#bindKey" class="tsd-kind-icon">bind<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#bindShiftKey" class="tsd-kind-icon">bind<wbr/>Shift<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#escape" class="tsd-kind-icon">escape</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#getFunction" class="tsd-kind-icon">get<wbr/>Function</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#isControlDown" class="tsd-kind-icon">is<wbr/>Control<wbr/>Down</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#isEnabled" class="tsd-kind-icon">is<wbr/>Enabled</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#isEnabledForEvent" class="tsd-kind-icon">is<wbr/>Enabled<wbr/>For<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#isEventIgnored" class="tsd-kind-icon">is<wbr/>Event<wbr/>Ignored</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#isGraphEvent" class="tsd-kind-icon">is<wbr/>Graph<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#keyDown" class="tsd-kind-icon">key<wbr/>Down</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#onDestroy" class="tsd-kind-icon">on<wbr/>Destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="KeyHandler.html#setEnabled" class="tsd-kind-icon">set<wbr/>Enabled</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>