Skip to content

Commit

Permalink
Prep 3.4 release
Browse files Browse the repository at this point in the history
  • Loading branch information
David Mesquita-Morris committed Oct 11, 2021
1 parent 8535970 commit a8d5f47
Show file tree
Hide file tree
Showing 11 changed files with 138 additions and 202 deletions.
2 changes: 1 addition & 1 deletion docs/api/v3/assets/js/search.js
View file

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

54 changes: 2 additions & 52 deletions docs/api/v3/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ <h3>Interfaces</h3>
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-has-type-parameter"><a href="index.html#merge" class="tsd-kind-icon">merge</a></li>
<li class="tsd-kind-function tsd-has-type-parameter"><a href="index.html#split" class="tsd-kind-icon">split</a></li>
<li class="tsd-kind-function tsd-has-type-parameter"><a href="index.html#table" class="tsd-kind-icon">table</a></li>
</ul>
</section>
Expand All @@ -89,7 +88,7 @@ <h3>merge</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/a8621b6/src/index.ts#L102">index.ts:102</a></li>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/8535970/src/index.ts#L81">index.ts:81</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -128,52 +127,6 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter">
<a name="split" class="tsd-anchor"></a>
<h3>split</h3>
<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">split&lt;TRow&gt;<span class="tsd-signature-symbol">(</span>keys<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Cube</span><span class="tsd-signature-symbol">&lt;</span><a href="interfaces/cell.html" class="tsd-signature-type" data-tsd-kind="Interface">Cell</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TRow</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span>, axes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Axes</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TRow</span><span class="tsd-signature-symbol">&gt;</span>, onX<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><a href="interfaces/cell.html" class="tsd-signature-type" data-tsd-kind="Interface">Cell</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TRow</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</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/a8621b6/src/index.ts#L65">index.ts:65</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Splits a cube of keys into a table, creating mutiple rows or columns where a cell in a cube has multiple values.</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>TRow<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Row</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>keys: <span class="tsd-signature-type">Cube</span><span class="tsd-signature-symbol">&lt;</span><a href="interfaces/cell.html" class="tsd-signature-type" data-tsd-kind="Interface">Cell</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TRow</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5>axes: <span class="tsd-signature-type">Axes</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TRow</span><span class="tsd-signature-symbol">&gt;</span></h5>
<div class="tsd-comment tsd-typography">
<p>The x and y axes used in the pivot operation to create the cube.</p>
</div>
</li>
<li>
<h5>onX: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>A flag to indicate if cells in cube containing multiple values should be split on the x axis (if not, the y axis will be used).</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="interfaces/cell.html" class="tsd-signature-type" data-tsd-kind="Interface">Cell</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TRow</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter">
<a name="table" class="tsd-anchor"></a>
<h3>table</h3>
Expand All @@ -184,7 +137,7 @@ <h3>table</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/a8621b6/src/index.ts#L30">index.ts:30</a></li>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/8535970/src/index.ts#L30">index.ts:30</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -250,9 +203,6 @@ <h4 class="tsd-returns-title">Returns <a href="interfaces/cell.html" class="tsd-
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="index.html#merge" class="tsd-kind-icon">merge</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="index.html#split" class="tsd-kind-icon">split</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="index.html#table" class="tsd-kind-icon">table</a>
</li>
Expand Down
13 changes: 5 additions & 8 deletions docs/api/v3/interfaces/cell.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ <h3>cols</h3>
<div class="tsd-signature tsd-kind-icon">cols<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/a8621b6/src/index.ts#L20">index.ts:20</a></li>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/8535970/src/index.ts#L20">index.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -131,7 +131,7 @@ <h3>rows</h3>
<div class="tsd-signature tsd-kind-icon">rows<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/a8621b6/src/index.ts#L17">index.ts:17</a></li>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/8535970/src/index.ts#L17">index.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -146,7 +146,7 @@ <h3>source</h3>
<div class="tsd-signature tsd-kind-icon">source<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TRow</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/a8621b6/src/index.ts#L14">index.ts:14</a></li>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/8535970/src/index.ts#L14">index.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -162,7 +162,7 @@ <h3>style</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="key.html">Key</a>.<a href="key.html#style">style</a></p>
<ul>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/a8621b6/src/index.ts#L8">index.ts:8</a></li>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/8535970/src/index.ts#L8">index.ts:8</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -178,7 +178,7 @@ <h3>text</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="key.html">Key</a>.<a href="key.html#text">text</a></p>
<ul>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/a8621b6/src/index.ts#L5">index.ts:5</a></li>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/8535970/src/index.ts#L5">index.ts:5</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -229,9 +229,6 @@ <h3>text</h3>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="../index.html#merge" class="tsd-kind-icon">merge</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="../index.html#split" class="tsd-kind-icon">split</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="../index.html#table" class="tsd-kind-icon">table</a>
</li>
Expand Down
7 changes: 2 additions & 5 deletions docs/api/v3/interfaces/key.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h3>style</h3>
<div class="tsd-signature tsd-kind-icon">style<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/a8621b6/src/index.ts#L8">index.ts:8</a></li>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/8535970/src/index.ts#L8">index.ts:8</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -113,7 +113,7 @@ <h3>text</h3>
<div class="tsd-signature tsd-kind-icon">text<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/a8621b6/src/index.ts#L5">index.ts:5</a></li>
<li>Defined in <a href="https://github.com/steelbreeze/landscape/blob/8535970/src/index.ts#L5">index.ts:5</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -155,9 +155,6 @@ <h3>text</h3>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="../index.html#merge" class="tsd-kind-icon">merge</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="../index.html#split" class="tsd-kind-icon">split</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="../index.html#table" class="tsd-kind-icon">table</a>
</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/dist/landscape.min.js
View file

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

7 changes: 0 additions & 7 deletions lib/node/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,6 @@ export interface Cell<TRow extends Row> extends Key {
* @param onX A flag to indicate if cells in cube containing multiple values should be split on the x axis (if not, the y axis will be used).
*/
export declare function table<TRow extends Row>(cube: Cube<TRow>, axes: Axes<TRow>, getKey: Func1<TRow, Key>, onX: boolean): Array<Array<Cell<TRow>>>;
/**
* Splits a cube of keys into a table, creating mutiple rows or columns where a cell in a cube has multiple values.
* @param cube The source cube.
* @param axes The x and y axes used in the pivot operation to create the cube.
* @param onX A flag to indicate if cells in cube containing multiple values should be split on the x axis (if not, the y axis will be used).
*/
export declare function split<TRow extends Row>(cells: Cube<Cell<TRow>>, axes: Axes<TRow>, onX: boolean): Array<Array<Cell<TRow>>>;
/**
* Merge adjacent cells in a split table on the y and/or x axes.
* @param table A table of Cells created by a previous call to splitX or splitY.
Expand Down
Loading

0 comments on commit a8d5f47

Please sign in to comment.