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

Updated 3.1 Advanced grid (markdown)

koalyptus 2015-06-13 17:23:14 +10:00
parent ecf5a65347
commit b2c493a1cc
1 changed files with 116 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

117
3.1-Advanced-grid.md

@ -1,4 +1,119 @@
<p>Advanced selection, keyboard navigation and inline components are delivered by the <code>advancedGrid</code> extension combined with the powerful <a href="http://edittable.free.fr/zip.php?f=ezEditTable.zip&amp;p=1" target="_blank" title="ezEditTable is a javascript code aimed at enhancing regular HTML tables by adding features such as inline editing components, advanced selection and keyboard navigation - Developed by Max Guglielmi">ezEditTable</a> plugin.</p>
<p>To get the <code>advancedGrid</code> extension instance:</p>
<pre>var advancedGrid = myTF.getExtension('advancedGrid');</pre>
<pre>var advancedGrid = myTF.getExtension('advancedGrid');</pre>
<table>
<thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
<th>Remarks</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<th>name</th>
<td>string</td>
<td><p>name of the extension, it should match the name of the directory and of the file, in this case 'advancedGrid'.</p>
</td>
<td>
<p>Check the <a href="http://edittable.free.fr/doc.php" target="_blank">ezEditTable documentation</a> section in order to see the available properties.</p>
</td>
<td><code>var tfConfig = { extensions: [{ name: 'advancedGrid' }] };</code></td>
</tr>
<tr>
<th>vendor_path</th>
<td>string</td>
<td>
this is a mandatory property defining the path to the vendor's ezEditTable library
</td>
<td>
It can be a URL too ie: 'http://edittable.free.fr/ezEditTable/'
</td>
<td><pre>
var tfConfig = {
extensions: [{
name: 'advancedGrid',
vendor_path: 'path/to/ezEditTable'
}]
};</pre>
</td>
</tr>
<tr>
<th>filename</th>
<td>string</td>
<td>filename of the <a href="http://edittable.free.fr/zip.php?f=ezEditTable.zip&amp;p=1" target="_blank" title="ezEditTable is a javascript code aimed at enhancing regular HTML tables by adding features such as inline editing components, advanced selection and keyboard navigation - Developed by Max Guglielmi">ezEditTable (default - 'ezEditTable.js')</a> plugin </td>
<td></td>
<td>
<pre>
var tfConfig = {
extensions: [{
name: 'advancedGrid',
vendor_path: 'path/to/ezEditTable/',
filename: 'ezEditTable_min.js'
}]
};</pre>
</td>
</tr>
<tr>
<th>load_stylesheet</th>
<td>boolean</td>
<td>if set true it loads the vendor's stylesheet (default - false)</td>
<td></td>
<td>
<pre>
var tfConfig = {
extensions: [{
name: 'advancedGrid',
vendor_path: 'path/to/ezEditTable/',
filename: 'ezEditTable_min.js',
load_stylesheet: true
}]
};</pre>
</td>
</tr>
<tr>
<th>stylesheet</th>
<td>string</td>
<td>path/URL to the vendor's stylesheet (default - vendor_path + 'ezEditTable.css')</td>
<td>Note this property includes the filename</td>
<td>
<pre>
var tfConfig = {
extensions: [{
name: 'advancedGrid',
vendor_path: 'path/to/ezEditTable/',
filename: 'ezEditTable_min.js',
load_stylesheet: true,
stylesheet: 'path/to/ezEditTable/stylesheet/style.css'
}]
};</pre>
</td>
</tr>
</tbody>
</table>
<p>
The above configuration also includes all the ezEditTable configuration properties listed in the <a href="http://edittable.free.fr/doc.php" target="_blank">ezEditTable documentation</a>. As an example:
</p>
<pre>
var tfConfig = {
extensions: [{
name: 'advancedGrid',
vendor_path: 'path/to/ezEditTable/',
filename: 'ezEditTable_min.js',
load_stylesheet: true,
stylesheet: 'path/to/ezEditTable/stylesheet/style.css'
selectable: true,
editable: true,
default_selection: 'both',
auto_save: false
}]
};
</pre>