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

@@ -23,7 +23,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">LogPanel</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/panels/logpanel.ts#L4">src/panels/logpanel.ts:4</a></li></ul></aside>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/panels/logpanel.ts#L4">src/panels/logpanel.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">
@@ -73,7 +73,7 @@
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Overrides <a href="panels_panel.Panel.html">Panel</a>.<a href="panels_panel.Panel.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/panels/logpanel.ts#L14">src/panels/logpanel.ts:14</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/panels/logpanel.ts#L14">src/panels/logpanel.ts:14</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 tsd-is-inherited"><a id="_element" class="tsd-anchor"></a>
@@ -81,7 +81,7 @@
<div class="tsd-signature"><span class="tsd-kind-property">#element</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">HTMLElement</span></div><aside class="tsd-sources">
<p>Inherited from <a href="panels_panel.Panel.html">Panel</a>.<a href="panels_panel.Panel.html#_element">#element</a></p>
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/panels/panel.ts#L2">src/panels/panel.ts:2</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/panels/panel.ts#L2">src/panels/panel.ts:2</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_logs" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#logs</span><a href="#_logs" 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">#logs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></div>
@@ -91,28 +91,28 @@
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/panels/logpanel.ts#L8">src/panels/logpanel.ts:8</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/panels/logpanel.ts#L8">src/panels/logpanel.ts:8</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_open" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#open</span><a href="#_open" 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">#open</span><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/Pax1601/DCSOlympus/blob/fab7d26/client/src/panels/logpanel.ts#L5">src/panels/logpanel.ts:5</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/panels/logpanel.ts#L5">src/panels/logpanel.ts:5</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_queuedMessages" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#queued<wbr/>Messages</span><a href="#_queuedMessages" 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">#queued<wbr/>Messages</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 <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/panels/logpanel.ts#L6">src/panels/logpanel.ts:6</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/panels/logpanel.ts#L6">src/panels/logpanel.ts:6</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_scrolledDown" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#scrolled<wbr/>Down</span><a href="#_scrolledDown" 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">#scrolled<wbr/>Down</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 <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/panels/logpanel.ts#L7">src/panels/logpanel.ts:7</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/panels/logpanel.ts#L7">src/panels/logpanel.ts:7</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private tsd-is-inherited"><a id="_visible" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#visible</span><a href="#_visible" 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</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">
<p>Inherited from <a href="panels_panel.Panel.html">Panel</a>.<a href="panels_panel.Panel.html#_visible">#visible</a></p>
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/panels/panel.ts#L3">src/panels/panel.ts:3</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/panels/panel.ts#L3">src/panels/panel.ts:3</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_calculateHeight" class="tsd-anchor"></a>
@@ -122,7 +122,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/panels/logpanel.ts#L90">src/panels/logpanel.ts:90</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/panels/logpanel.ts#L90">src/panels/logpanel.ts:90</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_scrollDown" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#scroll<wbr/>Down</span><a href="#_scrollDown" 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 tsd-is-private">
@@ -130,7 +130,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/panels/logpanel.ts#L83">src/panels/logpanel.ts:83</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/panels/logpanel.ts#L83">src/panels/logpanel.ts:83</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_updateHeader" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#update<wbr/>Header</span><a href="#_updateHeader" 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 tsd-is-private">
@@ -138,7 +138,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/panels/logpanel.ts#L73">src/panels/logpanel.ts:73</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/panels/logpanel.ts#L73">src/panels/logpanel.ts:73</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="appendLog" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>append<wbr/>Log</span><a href="#appendLog" 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">
@@ -151,7 +151,7 @@
<h5><span class="tsd-kind-parameter">log</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">
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/panels/logpanel.ts#L57">src/panels/logpanel.ts:57</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/panels/logpanel.ts#L57">src/panels/logpanel.ts:57</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="appendLogs" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>append<wbr/>Logs</span><a href="#appendLogs" 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">
@@ -167,7 +167,7 @@
<h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/panels/logpanel.ts#L48">src/panels/logpanel.ts:48</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/panels/logpanel.ts#L48">src/panels/logpanel.ts:48</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getElement" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Element</span><a href="#getElement" 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 tsd-is-inherited">
@@ -176,7 +176,7 @@
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">HTMLElement</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="panels_panel.Panel.html">Panel</a>.<a href="panels_panel.Panel.html#getElement">getElement</a></p>
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/panels/panel.ts#L31">src/panels/panel.ts:31</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/panels/panel.ts#L31">src/panels/panel.ts:31</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getVisible" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Visible</span><a href="#getVisible" 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 tsd-is-inherited">
@@ -185,7 +185,7 @@
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="panels_panel.Panel.html">Panel</a>.<a href="panels_panel.Panel.html#getVisible">getVisible</a></p>
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/panels/panel.ts#L35">src/panels/panel.ts:35</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/panels/panel.ts#L35">src/panels/panel.ts:35</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><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 tsd-is-inherited">
@@ -194,7 +194,7 @@
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="panels_panel.Panel.html">Panel</a>.<a href="panels_panel.Panel.html#hide">hide</a></p>
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/panels/panel.ts#L18">src/panels/panel.ts:18</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/panels/panel.ts#L18">src/panels/panel.ts:18</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">
@@ -203,7 +203,7 @@
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Overrides <a href="panels_panel.Panel.html">Panel</a>.<a href="panels_panel.Panel.html#show">show</a></p>
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/panels/logpanel.ts#L43">src/panels/logpanel.ts:43</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/panels/logpanel.ts#L43">src/panels/logpanel.ts:43</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="toggle" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>toggle</span><a href="#toggle" 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 tsd-is-inherited">
@@ -212,7 +212,7 @@
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="panels_panel.Panel.html">Panel</a>.<a href="panels_panel.Panel.html#toggle">toggle</a></p>
<ul>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fab7d26/client/src/panels/panel.ts#L23">src/panels/panel.ts:23</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/Pax1601/DCSOlympus/blob/fe0e964/client/src/panels/panel.ts#L23">src/panels/panel.ts:23</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
@@ -273,6 +273,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>