deblan-mirror/TableFilter
1
0
Fork 0
mirror of https://github.com/koalyptus/TableFilter.git synced 2024-06-08 00:42:28 +02:00
Code Issues Releases Wiki Activity

Updated 2.2 Public methods (markdown)

koalyptus 2015-11-07 19:21:22 +11:00
parent f38a6621da
commit 615987af68
1 changed files with 22 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
2.2-Public-methods.md

@ -129,11 +129,13 @@
<td><code>myTF.setFilterValue(1, 'my search string');</code></td>
</tr>
<tr>
<th>getColValues(colindex, num, exclude)</th>
<th>getColValues(colIndex, includeHeaders, num, exclude)</th>
<td><p>return the data of a specified colum:</p>
<ul>
<li>colindex: column index (number)</li>
<li>num: a boolean set to true if we want only numbers to be returned (used for column calculations) </li>
<li>colIndex: column index (number)</li>
<li>includeHeaders (optional): if set true the column's header text is included in
returned array (boolean)</li>
<li>num (optional): a boolean set to true if we want only numbers to be returned (used for column calculations) - deafult false</li>
<li>exclude (optional): array containing rows indexes to be excluded
from returned values</li>
</ul></td>
@ -152,11 +154,11 @@
<td><code>myTF.getValidRowsIndex();</code></td>
</tr>
<tr>
<th>GetStartRowIndex()</th>
<th>getStartRowIndex()</th>
<td>return the index of the row from which will start the filtering
process</td>
<td></td>
<td><code>myTF.GetStartRowIndex();</code></td>
<td><code>myTF.getStartRowIndex();</code></td>
</tr>
<tr>
<th>getLastRowIndex()</th>
@ -188,7 +190,7 @@
</pre>
Param:
<ul>
<li>includeHeaders: if set true header captions are included in
<li>includeHeaders (optional): if set true header captions are included in
returned array (boolean)</li>
</ul>
</td>
@ -207,16 +209,16 @@
</pre>
Param:
<ul>
<li>includeHeaders: if set true header captions are included in
<li>includeHeaders (optional): if set true header captions are included in
returned array (boolean)</li>
</ul></td>
<td></td>
<td><code>myTF.getFilteredData();</code></td>
</tr>
<tr>
<th>getFilteredDataCol(colIndex)</th>
<th>getFilteredDataCol(colIndex, includeHeaders)</th>
<td><p>return an array containing the filtered data of a
specified column. The returned array is formated in the following
specified column. The returned array is formatted in the following
manner: </p>
<pre>
[
@ -224,6 +226,11 @@
[rowIndex, [value0, value1...]]
]
</pre>
Param:
<ul>
<li>includeHeaders (optional): if set true the column's header text is included in
returned array (boolean)</li>
</ul>
</td>
<td></td>
<td><code>var a = myTF.getFilteredDataCol(3);</code></td>
@ -257,5 +264,11 @@
<td></td>
<td><code>var nbFilterableRows = myTF.getFilterableRowsNb();</code></td>
</tr>
<tr>
<th>getHeadersText()</th>
<td>return an array containing the header's text of each column</td>
<td></td>
<td><code>var headers = myTF.getHeadersText();</code></td>
</tr>
</tbody>
</table>