Skip to content

Commit

Permalink
Refresh docs
Browse files Browse the repository at this point in the history
  • Loading branch information
David Mesquita-Morris committed Apr 30, 2020
1 parent 2134358 commit b64f03f
Show file tree
Hide file tree
Showing 10 changed files with 21 additions and 80 deletions.
2 changes: 1 addition & 1 deletion docs/api/v1/assets/js/search.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

43 changes: 4 additions & 39 deletions docs/api/v1/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@ <h3>Interfaces</h3>
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function"><a href="index.html#deriveaxes" class="tsd-kind-icon">derive<wbr>Axes</a></li>
<li class="tsd-kind-function"><a href="index.html#gethtml" class="tsd-kind-icon">getHTML</a></li>
<li class="tsd-kind-function"><a href="index.html#getoptimalaxes" class="tsd-kind-icon">get<wbr>Optimal<wbr>Axes</a></li>
<li class="tsd-kind-function"><a href="index.html#gettable" class="tsd-kind-icon">get<wbr>Table</a></li>
<li class="tsd-kind-function"><a href="index.html#preparedata" class="tsd-kind-icon">prepare<wbr>Data</a></li>
Expand All @@ -101,7 +100,7 @@ <h3>derive<wbr>Axes</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/ddd0e1b/src/deriveAxis.ts#L11">deriveAxis.ts:11</a></li>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/2134358/src/deriveAxis.ts#L11">deriveAxis.ts:11</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -135,37 +134,6 @@ <h4 class="tsd-returns-title">Returns <a href="interfaces/iaxes.html" class="tsd
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="gethtml" class="tsd-anchor"></a>
<h3>getHTML</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">getHTML<span class="tsd-signature-symbol">(</span>table<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="interfaces/iapplication.html" class="tsd-signature-type">IApplication</a><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/ilayout.html" class="tsd-signature-type">ILayout</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/ddd0e1b/src/getHTML.ts#L8">getHTML.ts:8</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Renders a table as HTML.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>table: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="interfaces/iapplication.html" class="tsd-signature-type">IApplication</a><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/ilayout.html" class="tsd-signature-type">ILayout</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h5>
<div class="tsd-comment tsd-typography">
<p>The application table, returned by [getTable]</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="getoptimalaxes" class="tsd-anchor"></a>
<h3>get<wbr>Optimal<wbr>Axes</h3>
Expand All @@ -176,7 +144,7 @@ <h3>get<wbr>Optimal<wbr>Axes</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/ddd0e1b/src/getOptimalAxes.ts#L31">getOptimalAxes.ts:31</a></li>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/2134358/src/getOptimalAxes.ts#L31">getOptimalAxes.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -286,7 +254,7 @@ <h3>get<wbr>Table</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/ddd0e1b/src/getTable.ts#L10">getTable.ts:10</a></li>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/2134358/src/getTable.ts#L10">getTable.ts:10</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -323,7 +291,7 @@ <h3>prepare<wbr>Data</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/ddd0e1b/src/prepareData.ts#L10">prepareData.ts:10</a></li>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/2134358/src/prepareData.ts#L10">prepareData.ts:10</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -390,9 +358,6 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Array</sp
<li class=" tsd-kind-function">
<a href="index.html#deriveaxes" class="tsd-kind-icon">derive<wbr>Axes</a>
</li>
<li class=" tsd-kind-function">
<a href="index.html#gethtml" class="tsd-kind-icon">getHTML</a>
</li>
<li class=" tsd-kind-function">
<a href="index.html#getoptimalaxes" class="tsd-kind-icon">get<wbr>Optimal<wbr>Axes</a>
</li>
Expand Down
5 changes: 1 addition & 4 deletions docs/api/v1/interfaces/iapplication.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h3>detail</h3>
<div class="tsd-signature tsd-kind-icon">detail<span class="tsd-signature-symbol">:</span> <a href="idetail.html" class="tsd-signature-type">IDetail</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/ddd0e1b/src/IApplication.ts#L4">IApplication.ts:4</a></li>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/2134358/src/IApplication.ts#L4">IApplication.ts:4</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -155,9 +155,6 @@ <h3>detail</h3>
<li class=" tsd-kind-function">
<a href="../index.html#deriveaxes" class="tsd-kind-icon">derive<wbr>Axes</a>
</li>
<li class=" tsd-kind-function">
<a href="../index.html#gethtml" class="tsd-kind-icon">getHTML</a>
</li>
<li class=" tsd-kind-function">
<a href="../index.html#getoptimalaxes" class="tsd-kind-icon">get<wbr>Optimal<wbr>Axes</a>
</li>
Expand Down
7 changes: 2 additions & 5 deletions docs/api/v1/interfaces/iaxes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ <h3>x</h3>
<div class="tsd-signature tsd-kind-icon">x<span class="tsd-signature-symbol">:</span> <a href="iaxis.html" class="tsd-signature-type">IAxis</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/ddd0e1b/src/IAxes.ts#L6">IAxes.ts:6</a></li>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/2134358/src/IAxes.ts#L6">IAxes.ts:6</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -114,7 +114,7 @@ <h3>y</h3>
<div class="tsd-signature tsd-kind-icon">y<span class="tsd-signature-symbol">:</span> <a href="iaxis.html" class="tsd-signature-type">IAxis</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/ddd0e1b/src/IAxes.ts#L9">IAxes.ts:9</a></li>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/2134358/src/IAxes.ts#L9">IAxes.ts:9</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -174,9 +174,6 @@ <h3>y</h3>
<li class=" tsd-kind-function">
<a href="../index.html#deriveaxes" class="tsd-kind-icon">derive<wbr>Axes</a>
</li>
<li class=" tsd-kind-function">
<a href="../index.html#gethtml" class="tsd-kind-icon">getHTML</a>
</li>
<li class=" tsd-kind-function">
<a href="../index.html#getoptimalaxes" class="tsd-kind-icon">get<wbr>Optimal<wbr>Axes</a>
</li>
Expand Down
7 changes: 2 additions & 5 deletions docs/api/v1/interfaces/iaxis.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ <h3>name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/ddd0e1b/src/IAxis.ts#L4">IAxis.ts:4</a></li>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/2134358/src/IAxis.ts#L4">IAxis.ts:4</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -114,7 +114,7 @@ <h3>values</h3>
<div class="tsd-signature tsd-kind-icon">values<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/ddd0e1b/src/IAxis.ts#L7">IAxis.ts:7</a></li>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/2134358/src/IAxis.ts#L7">IAxis.ts:7</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -174,9 +174,6 @@ <h3>values</h3>
<li class=" tsd-kind-function">
<a href="../index.html#deriveaxes" class="tsd-kind-icon">derive<wbr>Axes</a>
</li>
<li class=" tsd-kind-function">
<a href="../index.html#gethtml" class="tsd-kind-icon">getHTML</a>
</li>
<li class=" tsd-kind-function">
<a href="../index.html#getoptimalaxes" class="tsd-kind-icon">get<wbr>Optimal<wbr>Axes</a>
</li>
Expand Down
7 changes: 2 additions & 5 deletions docs/api/v1/interfaces/idetail.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ <h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/ddd0e1b/src/IApplication.ts#L13">IApplication.ts:13</a></li>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/2134358/src/IApplication.ts#L13">IApplication.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -115,7 +115,7 @@ <h3>name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/ddd0e1b/src/IApplication.ts#L16">IApplication.ts:16</a></li>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/2134358/src/IApplication.ts#L16">IApplication.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -175,9 +175,6 @@ <h3>name</h3>
<li class=" tsd-kind-function">
<a href="../index.html#deriveaxes" class="tsd-kind-icon">derive<wbr>Axes</a>
</li>
<li class=" tsd-kind-function">
<a href="../index.html#gethtml" class="tsd-kind-icon">getHTML</a>
</li>
<li class=" tsd-kind-function">
<a href="../index.html#getoptimalaxes" class="tsd-kind-icon">get<wbr>Optimal<wbr>Axes</a>
</li>
Expand Down
Loading

0 comments on commit b64f03f

Please sign in to comment.