deblan-mirror/TableFilter
1
0
Fork 0
mirror of https://github.com/koalyptus/TableFilter.git synced 2024-06-07 16:32:39 +02:00
Code Issues Releases Wiki Activity

Updated 2.1 Public properties (markdown)

koalyptus 2016-05-08 16:27:22 +10:00
parent cced165c23
commit 2c149f642e
1 changed files with 2 additions and 90 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

92
2.1-Public-properties.md

@ -1,90 +1,2 @@
<table>
<thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
<th>Remarks</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<th>id</th>
<td>string</td>
<td>returns the HTML table's id passed to the TableFilter constructor</td>
<td></td>
<td><code>alert( myTF.id );</code></td>
</tr>
<tr>
<th>tbl</th>
<td>HTMLTableElement</td>
<td>returns the HTML table element used by the TF object</td>
<td></td>
<td><code>alert( myTF.tbl );</code></td>
</tr>
<tr>
<th>nbRows</th>
<td>number</td>
<td>returns total number of rows</td>
<td></td>
<td><code>alert( myTF.nbRows );</code></td>
</tr>
<tr>
<th>nbFilterableRows</th>
<td>number</td>
<td>returns the total number of filterable rows starting from the reference row index if defined</td>
<td></td>
<td><code>alert( myTF.nbFilterableRows );</code></td>
</tr>
<tr>
<th>infDiv</th>
<td>HTMLDivElement</td>
<td>returns the div element containing the left, middle and right divs</td>
<td></td>
<td><code>alert( myTF.infDiv );</code></td>
</tr>
<tr>
<th>lDiv</th>
<td>HTMLDivElement</td>
<td>returns the left div element</td>
<td></td>
<td><code>alert( myTF.lDiv );</code></td>
</tr>
<tr>
<th>mDiv</th>
<td>HTMLDivElement</td>
<td>returns the middle div element</td>
<td></td>
<td><code>alert( myTF.mDiv );</code></td>
</tr>
<tr>
<th>rDiv</th>
<td>HTMLDivElement</td>
<td>returns the right div element</td>
<td></td>
<td><code>alert( myTF.rDiv );</code></td>
</tr>
<tr>
<th>activeFlt</th>
<td>HTMLInputElement / HTMLSelectElement / HTMLUListElement</td>
<td>returns the active filter element</td>
<td>Returned object type depends on active filter type</td>
<td><code>alert( myTF.activeFlt );</code></td>
</tr>
<tr>
<th>activeFilterId</th>
<td>string</td>
<td>returns the id of the active filter</td>
<td></td>
<td><code>alert( myTF.activeFilterId );</code></td>
</tr>
<tr>
<th>externalFltEls</th>
<td>array</td>
<td>returns the list of external filter elements</td>
<td>Only if <code>external_flt_grid</code> property set true</td>
<td><code>alert( myTF.externalFltEls );</code></td>
</tr>
</tbody>
</table>
Refer to the auto-generated documentation:
[TableFilter class](http://koalyptus.github.io/TableFilter/docs/class/src/tablefilter.js~TableFilter.html)