library-mirrors/tablesorter
1
0
Fork 0
mirror of https://github.com/Mottie/tablesorter.git synced 2024-11-15 23:54:22 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Add filter getOptionSource function. See #671

Browse Source
This commit is contained in:
Rob Garrison 2018-07-20 16:58:44 -05:00
parent 90f7326819
commit 4dc56d145d
1 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/index.html
View File

@ -7908,6 +7908,7 @@ var index, len,
$table = $('table'),
column = 0, // first column
onlyAvail = false, // if true, available rows (visible rows after filtering) are returned
// arry is an array of all text content from a table column; duplicate entries are included!
array = $.tablesorter.filter.getOptions( $table, column, onlyAvail );
// process array; sort & remove duplicates (added v2.23.4)
@ -7925,6 +7926,38 @@ $('select.external').html( opts );</pre>
</td>
</tr>
<tr id="function-getoptionsource">
<td><a href="#" class="permalink">getOptionSource</a></td>
<td>This filter widget function returns all the cached values of the set table column (<span class="version">v2.16.0</span>):
<div class="collapsible"><br>
This function returns both the text and the parsed text for a column. So it <strong>ignores</strong> the <code>filter_useParsedData</code> option, <code>&quot;filter-parsed&quot;</code> class on the header, and the parser <code>parsed</code> flag settinng (<a href="example-parsers.html">ref</a>).
<p>Use it as follows:</p>
<pre class="prettyprint lang-js">$.tablesorter.filter.getOptionSource( table, column, onlyAvail );</pre>
<ul>
<li><code>table</code> - table DOM element (or jQuery object) of table.</li>
<li><code>column</code> - zero-based column index.</li>
<li><code>onlyAvail</code> - an optional boolean flag, which will be ignored if the <code>options</code> parameter is defined or is an empty string; otherwise it is the value passed to the function which finds all table column values; if <code>true</code>, only the available options will be diplayed.</li>
</ul>
Use this function as follows:<br>
<pre class="prettyprint lang-js">// external filter select
var index, len,
opts = '',
$table = $('table'),
column = 0, // first column
onlyAvail = false, // if true, available rows (visible rows after filtering) are returned
// arry is an array of objects [{ text: "Foo", parsed: "foo" }, ...] with duplicates entries removed
arry = $.tablesorter.filter.getOptionSource( $table, column, onlyAvail );
// build options
for ( index = 0; index &lt; len; index++ ) {
opts += '&lt;option value="' + array[ index ].parsed + '"&gt;' + array[ index ].text + '&lt;/option&gt;';
}
$('select.external').html( opts );</pre>
<p>Please be aware that this function is different from the <a href="#function-getoptions"><code>getOptions</code></a> filter function in that an object is returned.</p>
</div>
</td>
</tr>
<tr id="function-processoptions">
<td><a href="#" class="permalink">processOptions</a></td>
<td>This filter widget function returns an array of sorted column data will duplicates removed (<span class="version">v2.23.4</span>).