mirror of
https://github.com/koalyptus/TableFilter.git
synced 2024-06-14 03:35:30 +02:00
714 lines
16 KiB
HTML
714 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<base data-ice="baseUrl" href="../../../../">
|
|
<title data-ice="title">ColOps | TableFilter v0.0.0 API Document</title>
|
|
<link type="text/css" rel="stylesheet" href="css/style.css">
|
|
<link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css">
|
|
<script src="script/prettify/prettify.js"></script>
|
|
|
|
|
|
</head>
|
|
<body class="layout-container">
|
|
|
|
<header>
|
|
<a href="./">Home</a>
|
|
<a href="identifiers.html">Identifier</a>
|
|
<a href="source.html">Source</a>
|
|
|
|
<a data-ice="repoURL" href="https://github.com/koalyptus/TableFilter.git" class="repo-url-github">Repository</a>
|
|
<div class="search-box">
|
|
<span>
|
|
<img src="./image/search.png">
|
|
<span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span>
|
|
</span>
|
|
<ul class="search-result"></ul>
|
|
</div>
|
|
</header>
|
|
|
|
<nav class="navigation" data-ice="nav"><div data-ice="classWrap">
|
|
<h2>Class</h2>
|
|
<ul>
|
|
|
|
<li data-ice="classDoc"><span><a href="class/src/extensions/advancedGrid/adapterEzEditTable.js~AdapterEzEditTable.html">AdapterEzEditTable</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/extensions/sort/adapterSortabletable.js~AdapterSortableTable.html">AdapterSortableTable</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/alternateRows.js~AlternateRows.html">AlternateRows</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/checkList.js~CheckList.html">CheckList</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/clearButton.js~ClearButton.html">ClearButton</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/extensions/colOps/colOps.js~ColOps.html">ColOps</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/extensions/colsVisibility/colsVisibility.js~ColsVisibility.html">ColsVisibility</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/dropdown.js~Dropdown.html">Dropdown</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/extensions/filtersVisibility/filtersVisibility.js~FiltersVisibility.html">FiltersVisibility</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/gridLayout.js~GridLayout.html">GridLayout</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/help.js~Help.html">Help</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/highlightKeywords.js~HighlightKeyword.html">HighlightKeyword</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/loader.js~Loader.html">Loader</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/paging.js~Paging.html">Paging</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/popupFilter.js~PopupFilter.html">PopupFilter</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/rowsCounter.js~RowsCounter.html">RowsCounter</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/statusBar.js~StatusBar.html">StatusBar</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/store.js~Store.html">Store</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/tablefilter.js~TableFilter.html">TableFilter</a></span></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</nav>
|
|
|
|
<div class="content" data-ice="content"><div class="header-notice">
|
|
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import ColOps from '<span><a href="file/src/extensions/colOps/colOps.js.html#lineNumber5">TableFilter/src/extensions/colOps/colOps.js</a></span>'</code></pre></div>
|
|
<span data-ice="access">public</span>
|
|
<span data-ice="kind">class</span>
|
|
|
|
|
|
|
|
<span data-ice="source">| <span><a href="file/src/extensions/colOps/colOps.js.html#lineNumber5">source</a></span></span>
|
|
</div>
|
|
|
|
<div class="self-detail detail">
|
|
<h1 data-ice="name">ColOps</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="constructorSummary"><h2>Constructor Summary</h2><table class="summary" data-ice="summary">
|
|
<thead><tr><td data-ice="title" colspan="3">Public Constructor</td></tr></thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
<span data-ice="name"><span><a href="class/src/extensions/colOps/colOps.js~ColOps.html#instance-constructor-constructor">constructor</a></span></span><span data-ice="signature">(tf: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>)</span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
<div data-ice="description"><p>Column calculations</p>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div data-ice="memberSummary"><h2>Member Summary</h2><table class="summary" data-ice="summary">
|
|
<thead><tr><td data-ice="title" colspan="3">Public Members</td></tr></thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
<span data-ice="name"><span><a href="class/src/extensions/colOps/colOps.js~ColOps.html#instance-member-onAfterOperation">onAfterOperation</a></span></span><span data-ice="signature">: <span>*</span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
<span data-ice="name"><span><a href="class/src/extensions/colOps/colOps.js~ColOps.html#instance-member-onBeforeOperation">onBeforeOperation</a></span></span><span data-ice="signature">: <span>*</span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
<span data-ice="name"><span><a href="class/src/extensions/colOps/colOps.js~ColOps.html#instance-member-opts">opts</a></span></span><span data-ice="signature">: <span>*</span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
<span data-ice="name"><span><a href="class/src/extensions/colOps/colOps.js~ColOps.html#instance-member-tf">tf</a></span></span><span data-ice="signature">: <span>*</span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div data-ice="methodSummary"><h2>Method Summary</h2><table class="summary" data-ice="summary">
|
|
<thead><tr><td data-ice="title" colspan="3">Public Methods</td></tr></thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
<span data-ice="name"><span><a href="class/src/extensions/colOps/colOps.js~ColOps.html#instance-method-calc">calc</a></span></span><span data-ice="signature">()</span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
<div data-ice="description"><p>Calculates columns' values
|
|
</p></div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
<span data-ice="name"><span><a href="class/src/extensions/colOps/colOps.js~ColOps.html#instance-method-destroy">destroy</a></span></span><span data-ice="signature">()</span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
<span data-ice="name"><span><a href="class/src/extensions/colOps/colOps.js~ColOps.html#instance-method-init">init</a></span></span><span data-ice="signature">()</span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="constructorDetails"><h2 data-ice="title">Public Constructors</h2>
|
|
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="instance-constructor-constructor">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
<span data-ice="name">constructor</span><span data-ice="signature">(tf: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span>)</span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/extensions/colOps/colOps.js.html#lineNumber11">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
<div data-ice="description"><p>Column calculations</p>
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" data-depth="0">tf</td>
|
|
<td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>TableFilter instance</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div data-ice="memberDetails"><h2 data-ice="title">Public Members</h2>
|
|
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="instance-member-onAfterOperation">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
<span data-ice="name">onAfterOperation</span><span data-ice="signature">: <span>*</span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/extensions/colOps/colOps.js.html#lineNumber17">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="instance-member-onBeforeOperation">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
<span data-ice="name">onBeforeOperation</span><span data-ice="signature">: <span>*</span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/extensions/colOps/colOps.js.html#lineNumber14">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="instance-member-opts">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
<span data-ice="name">opts</span><span data-ice="signature">: <span>*</span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/extensions/colOps/colOps.js.html#lineNumber20">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="instance-member-tf">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
<span data-ice="name">tf</span><span data-ice="signature">: <span>*</span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/extensions/colOps/colOps.js.html#lineNumber21">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div data-ice="methodDetails"><h2 data-ice="title">Public Methods</h2>
|
|
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="instance-method-calc">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
<span data-ice="name">calc</span><span data-ice="signature">()</span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/extensions/colOps/colOps.js.html#lineNumber44">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
<div data-ice="description"><p>Calculates columns' values
|
|
Configuration options are stored in 'opts' property</p>
|
|
<ul>
|
|
<li>'id' contains ids of elements showing result (array)</li>
|
|
<li>'col' contains the columns' indexes (array)</li>
|
|
<li>'operation' contains operation type (array, values: 'sum', 'mean',
|
|
'min', 'max', 'median', 'q1', 'q3')</li>
|
|
<li>'write_method' array defines which method to use for displaying the
|
|
result (innerHTML, setValue, createTextNode) - default: 'innerHTML'</li>
|
|
<li><p>'tot_row_index' defines in which row results are displayed
|
|
(integers array)</p>
|
|
</li>
|
|
<li><p>changes made by Nuovella:
|
|
(1) optimized the routine (now it will only process each column once),
|
|
(2) added calculations for the median, lower and upper quartile.</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="properties">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="instance-method-destroy">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
<span data-ice="name">destroy</span><span data-ice="signature">()</span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/extensions/colOps/colOps.js.html#lineNumber313">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="instance-method-init">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
<span data-ice="name">init</span><span data-ice="signature">()</span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/extensions/colOps/colOps.js.html#lineNumber24">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div data-ice="properties">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer class="footer">
|
|
Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(0.1.4)</span></a>
|
|
</footer>
|
|
|
|
<script src="script/search_index.js"></script>
|
|
<script src="script/search.js"></script>
|
|
<script src="script/pretty-print.js"></script>
|
|
<script src="script/inherited-summary.js"></script>
|
|
<script src="script/test-summary.js"></script>
|
|
<script src="script/inner-link.js"></script>
|
|
<script src="script/patch-for-local.js"></script>
|
|
</body>
|
|
</html>
|