Updated documentation

This commit is contained in:
Pax1601
2023-09-03 16:45:48 +02:00
parent fe0e964a5a
commit 41e2e6fa59
221 changed files with 5816 additions and 2576 deletions

View File

@@ -16,6 +16,10 @@
<li><a href="../modules/contextmenus_contextmenu.html">contextmenus/contextmenu</a></li>
<li><a href="contextmenus_contextmenu.ContextMenu.html">ContextMenu</a></li></ul>
<h1>Class ContextMenu</h1></div>
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography"><p>Base class for map contextmenus. By default it is empty and requires to be extended.</p>
</div>
<div class="tsd-comment tsd-typography"></div></section>
<section class="tsd-panel tsd-hierarchy">
<h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
@@ -27,7 +31,7 @@
<li><a href="contextmenus_mapcontextmenu.MapContextMenu.html" class="tsd-signature-type tsd-kind-class">MapContextMenu</a></li>
<li><a href="contextmenus_unitcontextmenu.UnitContextMenu.html" class="tsd-signature-type tsd-kind-class">UnitContextMenu</a></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in src/contextmenus/contextmenu.ts:3</li></ul></aside>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/contextmenus/contextmenu.ts#L4">src/contextmenus/contextmenu.ts:4</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -40,7 +44,6 @@
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Properties</h3>
<div class="tsd-index-list"><a href="contextmenus_contextmenu.ContextMenu.html#_container" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>#container</span></a>
<a href="contextmenus_contextmenu.ContextMenu.html#_hidden" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>#hidden</span></a>
<a href="contextmenus_contextmenu.ContextMenu.html#_latlng" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>#latlng</span></a>
<a href="contextmenus_contextmenu.ContextMenu.html#_visibleSubMenu" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>#visible<wbr/>Sub<wbr/>Menu</span></a>
<a href="contextmenus_contextmenu.ContextMenu.html#_x" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>#x</span></a>
@@ -50,7 +53,6 @@
<h3 class="tsd-index-heading">Methods</h3>
<div class="tsd-index-list"><a href="contextmenus_contextmenu.ContextMenu.html#clip" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g></svg><span>clip</span></a>
<a href="contextmenus_contextmenu.ContextMenu.html#getContainer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Container</span></a>
<a href="contextmenus_contextmenu.ContextMenu.html#getHidden" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Hidden</span></a>
<a href="contextmenus_contextmenu.ContextMenu.html#getLatLng" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Lat<wbr/>Lng</span></a>
<a href="contextmenus_contextmenu.ContextMenu.html#getVisibleSubMenu" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Visible<wbr/>Sub<wbr/>Menu</span></a>
<a href="contextmenus_contextmenu.ContextMenu.html#getX" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>getX</span></a>
@@ -76,39 +78,34 @@
<h4 class="tsd-returns-title">Returns <a href="contextmenus_contextmenu.ContextMenu.html" class="tsd-signature-type tsd-kind-class">ContextMenu</a></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in src/contextmenus/contextmenu.ts:15</li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/contextmenus/contextmenu.ts#L15">src/contextmenus/contextmenu.ts:15</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_container" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#container</span><a href="#_container" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">#container</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 ">HTMLElement</span></div><aside class="tsd-sources">
<ul>
<li>Defined in src/contextmenus/contextmenu.ts:4</li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_hidden" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#hidden</span><a href="#_hidden" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">#hidden</span><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 src/contextmenus/contextmenu.ts:9</li></ul></aside></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/contextmenus/contextmenu.ts#L5">src/contextmenus/contextmenu.ts:5</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_latlng" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#latlng</span><a href="#_latlng" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">#latlng</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">LatLng</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
<ul>
<li>Defined in src/contextmenus/contextmenu.ts:5</li></ul></aside></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/contextmenus/contextmenu.ts#L6">src/contextmenus/contextmenu.ts:6</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_visibleSubMenu" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#visible<wbr/>Sub<wbr/>Menu</span><a href="#_visibleSubMenu" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">#visible<wbr/>Sub<wbr/>Menu</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">string</span><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources">
<ul>
<li>Defined in src/contextmenus/contextmenu.ts:8</li></ul></aside></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/contextmenus/contextmenu.ts#L9">src/contextmenus/contextmenu.ts:9</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_x" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#x</span><a href="#_x" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">#x</span><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 src/contextmenus/contextmenu.ts:6</li></ul></aside></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/contextmenus/contextmenu.ts#L7">src/contextmenus/contextmenu.ts:7</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_y" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#y</span><a href="#_y" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">#y</span><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 src/contextmenus/contextmenu.ts:7</li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/contextmenus/contextmenu.ts#L8">src/contextmenus/contextmenu.ts:8</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member"><a id="clip" class="tsd-anchor"></a>
@@ -116,95 +113,117 @@
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="clip.clip-1"><span class="tsd-kind-call-signature">clip</span><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><a href="#clip.clip-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<div class="tsd-comment tsd-typography"><p>Clips the contextmenu, meaning it moves it on the screen to make sure it does not overflow the window.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in src/contextmenus/contextmenu.ts:54</li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/contextmenus/contextmenu.ts#L76">src/contextmenus/contextmenu.ts:76</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getContainer" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Container</span><a href="#getContainer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="getContainer.getContainer-1"><span class="tsd-kind-call-signature">get<wbr/>Container</span><span class="tsd-signature-symbol">(</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 ">HTMLElement</span><a href="#getContainer.getContainer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">HTMLElement</span></h4><aside class="tsd-sources">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">HTMLElement</span></h4><p>The HTMLElement that contains the contextmenu</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in src/contextmenus/contextmenu.ts:34</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getHidden" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Hidden</span><a href="#getHidden" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="getHidden.getHidden-1"><span class="tsd-kind-call-signature">get<wbr/>Hidden</span><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><a href="#getHidden.getHidden-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in src/contextmenus/contextmenu.ts:50</li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/contextmenus/contextmenu.ts#L45">src/contextmenus/contextmenu.ts:45</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getLatLng" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Lat<wbr/>Lng</span><a href="#getLatLng" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="getLatLng.getLatLng-1"><span class="tsd-kind-call-signature">get<wbr/>Lat<wbr/>Lng</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">LatLng</span><a href="#getLatLng.getLatLng-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">LatLng</span></h4><aside class="tsd-sources">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">LatLng</span></h4><p>The Leaflet latlng object associated to the click that caused the contextmenu to be shown</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in src/contextmenus/contextmenu.ts:38</li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/contextmenus/contextmenu.ts#L53">src/contextmenus/contextmenu.ts:53</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getVisibleSubMenu" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Visible<wbr/>Sub<wbr/>Menu</span><a href="#getVisibleSubMenu" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="getVisibleSubMenu.getVisibleSubMenu-1"><span class="tsd-kind-call-signature">get<wbr/>Visible<wbr/>Sub<wbr/>Menu</span><span class="tsd-signature-symbol">(</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">string</span><a href="#getVisibleSubMenu.getVisibleSubMenu-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4><p>The name of the currently visible submenu</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in src/contextmenus/contextmenu.ts:72</li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/contextmenus/contextmenu.ts#L102">src/contextmenus/contextmenu.ts:102</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getX" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>getX</span><a href="#getX" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="getX.getX-1"><span class="tsd-kind-call-signature">getX</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getX.getX-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The x coordinate of the top left corner of the menu</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in src/contextmenus/contextmenu.ts:42</li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/contextmenus/contextmenu.ts#L61">src/contextmenus/contextmenu.ts:61</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getY" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>getY</span><a href="#getY" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="getY.getY-1"><span class="tsd-kind-call-signature">getY</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getY.getY-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The y coordinate of the top left corner of the menu</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in src/contextmenus/contextmenu.ts:46</li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/contextmenus/contextmenu.ts#L69">src/contextmenus/contextmenu.ts:69</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="hide" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>hide</span><a href="#hide" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="hide.hide-1"><span class="tsd-kind-call-signature">hide</span><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><a href="#hide.hide-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<div class="tsd-comment tsd-typography"><p>Hide the contextmenu</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in src/contextmenus/contextmenu.ts:29</li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/contextmenus/contextmenu.ts#L37">src/contextmenus/contextmenu.ts:37</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="setVisibleSubMenu" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>set<wbr/>Visible<wbr/>Sub<wbr/>Menu</span><a href="#setVisibleSubMenu" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="setVisibleSubMenu.setVisibleSubMenu-1"><span class="tsd-kind-call-signature">set<wbr/>Visible<wbr/>Sub<wbr/>Menu</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">menu</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setVisibleSubMenu.setVisibleSubMenu-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Sets the currently visible submenu</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">menu</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<h5><span class="tsd-kind-parameter">menu</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>The name of the currently visibile submenu, or null if no submenu is visible</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in src/contextmenus/contextmenu.ts:68</li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/contextmenus/contextmenu.ts#L94">src/contextmenus/contextmenu.ts:94</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="show" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>show</span><a href="#show" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="show.show-1"><span class="tsd-kind-call-signature">show</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span>, <span class="tsd-kind-parameter">y</span>, <span class="tsd-kind-parameter">latlng</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#show.show-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Show the contextmenu on top of the map, usually at the location where the user has clicked on it.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">number</span></h5></li>
<h5><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>X screen coordinate of the top left corner of the context menu</p>
</div></li>
<li>
<h5><span class="tsd-kind-parameter">y</span>: <span class="tsd-signature-type">number</span></h5></li>
<h5><span class="tsd-kind-parameter">y</span>: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>Y screen coordinate of the top left corner of the context menu</p>
</div></li>
<li>
<h5><span class="tsd-kind-parameter">latlng</span>: <span class="tsd-signature-type ">LatLng</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<h5><span class="tsd-kind-parameter">latlng</span>: <span class="tsd-signature-type ">LatLng</span></h5>
<div class="tsd-comment tsd-typography"><p>Leaflet latlng object of the mouse click</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in src/contextmenus/contextmenu.ts:20</li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/contextmenus/contextmenu.ts#L26">src/contextmenus/contextmenu.ts:26</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
@@ -226,14 +245,12 @@
<ul>
<li><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a></li>
<li><a href="#_container" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>#container</span></a></li>
<li><a href="#_hidden" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>#hidden</span></a></li>
<li><a href="#_latlng" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>#latlng</span></a></li>
<li><a href="#_visibleSubMenu" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>#visible<wbr/>Sub<wbr/>Menu</span></a></li>
<li><a href="#_x" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>#x</span></a></li>
<li><a href="#_y" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>#y</span></a></li>
<li><a href="#clip" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>clip</span></a></li>
<li><a href="#getContainer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Container</span></a></li>
<li><a href="#getHidden" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Hidden</span></a></li>
<li><a href="#getLatLng" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Lat<wbr/>Lng</span></a></li>
<li><a href="#getVisibleSubMenu" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Visible<wbr/>Sub<wbr/>Menu</span></a></li>
<li><a href="#getX" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>getX</span></a></li>
@@ -269,6 +286,7 @@
<li><a href="../modules/map_destinationpreviewmarker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>map/destinationpreviewmarker</span></a></li>
<li><a href="../modules/map_drawingcursor.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>map/drawingcursor</span></a></li>
<li><a href="../modules/map_map.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>map/map</span></a></li>
<li><a href="../modules/map_smokemarker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>map/smokemarker</span></a></li>
<li><a href="../modules/map_targetmarker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>map/targetmarker</span></a></li>
<li><a href="../modules/map_temporaryunitmarker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>map/temporaryunitmarker</span></a></li>
<li><a href="../modules/mission_airbase.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>mission/airbase</span></a></li>