@steelbreeze/pivot
Version:
Minimal TypeScript / JavaScript n-cube library
22 lines (20 loc) • 20 kB
HTML
<html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>pivot | @steelbreeze/pivot</title><meta name="description" content="Documentation for @steelbreeze/pivot"/><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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">@steelbreeze/pivot</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@steelbreeze/pivot</a></li><li><a href="pivot.html">pivot</a></li></ul><h1>Function pivot</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Slices and dices source data by one or more dimensions, returning, <a href="../types/Matrix.html" class="tsd-kind-type-alias">Matrix</a>, <a href="../types/Cube.html" class="tsd-kind-type-alias">Cube</a> or <a href="../types/Hypercube.html" class="tsd-kind-type-alias">Hypercube</a> depending on the number of dimensions passed.
See the overloads for more detail.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example" class="tsd-anchor"></a>Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The following code creates a <a href="../types/Cube.html" class="tsd-kind-type-alias">Cube</a>, slicing and dicing the squad data for a football team by player position and country:</p>
<pre><code class="ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">x</span><span class="hl-1"> = </span><span class="hl-3">dimension</span><span class="hl-1">(</span><span class="hl-4">positions</span><span class="hl-1">, </span><span class="hl-3">property</span><span class="hl-1"><</span><span class="hl-5">Player</span><span class="hl-1">>(</span><span class="hl-6">'position'</span><span class="hl-1">)); </span><span class="hl-7">// using the built-in dimension generator matching a property</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">y</span><span class="hl-1"> = </span><span class="hl-3">dimension</span><span class="hl-1">(</span><span class="hl-4">countries</span><span class="hl-1">, (</span><span class="hl-4">country</span><span class="hl-1">: </span><span class="hl-5">string</span><span class="hl-1">) </span><span class="hl-0">=></span><span class="hl-1"> (</span><span class="hl-4">player</span><span class="hl-1">: </span><span class="hl-5">Player</span><span class="hl-1">) </span><span class="hl-0">=></span><span class="hl-1"> </span><span class="hl-4">player</span><span class="hl-1">.</span><span class="hl-4">country</span><span class="hl-1"> === </span><span class="hl-4">country</span><span class="hl-1">); </span><span class="hl-7">// using a user-defined generator</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">cube</span><span class="hl-1">: </span><span class="hl-5">Cube</span><span class="hl-1"><</span><span class="hl-5">Player</span><span class="hl-1">> = </span><span class="hl-3">pivot</span><span class="hl-1">(</span><span class="hl-4">squad</span><span class="hl-1">, </span><span class="hl-4">y</span><span class="hl-1">, </span><span class="hl-4">x</span><span class="hl-1">);</span>
</code><button type="button">Copy</button></pre>
</div></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="pivot" class="tsd-anchor"></a><span class="tsd-kind-call-signature">pivot</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue">TValue</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue">TValue</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">first</span><span class="tsd-signature-symbol">:</span> <a href="../types/Dimension.html" class="tsd-signature-type tsd-kind-type-alias">Dimension</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue">TValue</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/Matrix.html" class="tsd-signature-type tsd-kind-type-alias">Matrix</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue">TValue</a><span class="tsd-signature-symbol">></span><a href="#pivot" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Slices data by two dimensions, returning a <a href="../types/Cube.html" class="tsd-kind-type-alias">Cube</a>.</p>
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="pivottvalue" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TValue</span></span><div class="tsd-comment tsd-typography"><p>The type of the source data to be sliced and diced.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">source</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue">TValue</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The source data, an array of objects.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">first</span>: <a href="../types/Dimension.html" class="tsd-signature-type tsd-kind-type-alias">Dimension</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue">TValue</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The first dimension to slice the data by.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/Matrix.html" class="tsd-signature-type tsd-kind-type-alias">Matrix</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue">TValue</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/steelbreeze/pivot/blob/2324d0b7a017f98e781eb50252721a2b6911c8de/src/index.ts#L127">index.ts:127</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link"><a id="pivot-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">pivot</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue-1">TValue</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue-1">TValue</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">first</span><span class="tsd-signature-symbol">:</span> <a href="../types/Dimension.html" class="tsd-signature-type tsd-kind-type-alias">Dimension</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue-1">TValue</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">second</span><span class="tsd-signature-symbol">:</span> <a href="../types/Dimension.html" class="tsd-signature-type tsd-kind-type-alias">Dimension</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue-1">TValue</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/Cube.html" class="tsd-signature-type tsd-kind-type-alias">Cube</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue-1">TValue</a><span class="tsd-signature-symbol">></span><a href="#pivot-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Slices data by two dimensions, returning a <a href="../types/Cube.html" class="tsd-kind-type-alias">Cube</a>.</p>
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="pivottvalue-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TValue</span></span><div class="tsd-comment tsd-typography"><p>The type of the source data to be sliced and diced.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">source</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue-1">TValue</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The source data, an array of objects.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">first</span>: <a href="../types/Dimension.html" class="tsd-signature-type tsd-kind-type-alias">Dimension</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue-1">TValue</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The first dimension to slice the data by.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">second</span>: <a href="../types/Dimension.html" class="tsd-signature-type tsd-kind-type-alias">Dimension</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue-1">TValue</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The second dimension to dice the data by.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/Cube.html" class="tsd-signature-type tsd-kind-type-alias">Cube</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue-1">TValue</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/steelbreeze/pivot/blob/2324d0b7a017f98e781eb50252721a2b6911c8de/src/index.ts#L136">index.ts:136</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link"><a id="pivot-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">pivot</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue-2">TValue</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue-2">TValue</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">first</span><span class="tsd-signature-symbol">:</span> <a href="../types/Dimension.html" class="tsd-signature-type tsd-kind-type-alias">Dimension</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue-2">TValue</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">others</span><span class="tsd-signature-symbol">:</span> <a href="../types/Dimension.html" class="tsd-signature-type tsd-kind-type-alias">Dimension</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue-2">TValue</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/Hypercube.html" class="tsd-signature-type tsd-kind-type-alias">Hypercube</a><a href="#pivot-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Slices data by three or more dimensions, returning a <a href="../types/Hypercube.html" class="tsd-kind-type-alias">Hypercube</a>.</p>
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="pivottvalue-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TValue</span></span><div class="tsd-comment tsd-typography"><p>The type of the source data to be sliced and diced.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">source</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue-2">TValue</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The source data, an array of objects.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">first</span>: <a href="../types/Dimension.html" class="tsd-signature-type tsd-kind-type-alias">Dimension</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue-2">TValue</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The first dimension to slice the data by.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">others</span>: <a href="../types/Dimension.html" class="tsd-signature-type tsd-kind-type-alias">Dimension</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="pivot.html#pivottvalue-2">TValue</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Two or more other dimensions to pivot the data by.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/Hypercube.html" class="tsd-signature-type tsd-kind-type-alias">Hypercube</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/steelbreeze/pivot/blob/2324d0b7a017f98e781eb50252721a2b6911c8de/src/index.ts#L145">index.ts:145</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">@steelbreeze/pivot</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>