docs/api/v1/interfaces/axes.html
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Axes | Pivot</title>
<meta name="description" content="Documentation for Pivot">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</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">Pivot</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">Pivot</a>
</li>
<li>
<a href="axes.html">Axes</a>
</li>
</ul>
<h1>Interface Axes<TRow></h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A pair of axes to be used in a pivot operation.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>TRow<span class="tsd-signature-symbol">: </span><a href="../index.html#row" class="tsd-signature-type" data-tsd-kind="Type alias">Row</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Axes</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="axes.html#x" class="tsd-kind-icon">x</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="axes.html#y" class="tsd-kind-icon">y</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="x" class="tsd-anchor"></a>
<h3>x</h3>
<div class="tsd-signature tsd-kind-icon">x<span class="tsd-signature-symbol">:</span> <a href="../index.html#dimension" class="tsd-signature-type" data-tsd-kind="Type alias">Dimension</a><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/pivot/blob/80673e7/src/index.ts#L46">index.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The x axis; columns in the resultant pivot table.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="y" class="tsd-anchor"></a>
<h3>y</h3>
<div class="tsd-signature tsd-kind-icon">y<span class="tsd-signature-symbol">:</span> <a href="../index.html#dimension" class="tsd-signature-type" data-tsd-kind="Type alias">Dimension</a><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/pivot/blob/80673e7/src/index.ts#L49">index.ts:49</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The y axis; rows in the resultant pivot table.</p>
</div>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-has-type-parameter">
<a href="axes.html" class="tsd-kind-icon">Axes</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="axes.html#x" class="tsd-kind-icon">x</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="axes.html#y" class="tsd-kind-icon">y</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="criterion.html" class="tsd-kind-icon">Criterion</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="options.html" class="tsd-kind-icon">Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="pair.html" class="tsd-kind-icon">Pair</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../index.html#criteria" class="tsd-kind-icon">Criteria</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../index.html#cube" class="tsd-kind-icon">Cube</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../index.html#dimension" class="tsd-kind-icon">Dimension</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../index.html#func1" class="tsd-kind-icon">Func1</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../index.html#func2" class="tsd-kind-icon">Func2</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../index.html#key" class="tsd-kind-icon">Key</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../index.html#predicate" class="tsd-kind-icon">Predicate</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../index.html#row" class="tsd-kind-icon">Row</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../index.html#table" class="tsd-kind-icon">Table</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../index.html#value" class="tsd-kind-icon">Value</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="../index.html#average" class="tsd-kind-icon">average</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="../index.html#count" class="tsd-kind-icon">count</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="../index.html#cube" class="tsd-kind-icon">cube</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="../index.html#derivedimension" class="tsd-kind-icon">derive<wbr>Dimension</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="../index.html#dimension" class="tsd-kind-icon">dimension</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="../index.html#filter" class="tsd-kind-icon">filter</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="../index.html#join" class="tsd-kind-icon">join</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="../index.html#map" class="tsd-kind-icon">map</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="../index.html#select" class="tsd-kind-icon">select</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="../index.html#sum" class="tsd-kind-icon">sum</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>