From 1db14d73dad7dd6cfbe7a7897da8f3193072303d Mon Sep 17 00:00:00 2001 From: Max Guglielmi Date: Fri, 26 Jun 2015 18:11:16 +1000 Subject: [PATCH] Started filters visibility doc --- README.md | 171 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 171 insertions(+) diff --git a/README.md b/README.md index 726867f4..d2b262db 100644 --- a/README.md +++ b/README.md @@ -88,4 +88,175 @@ Find the complete documentation in the [WIKI](https://github.com/koalyptus/Table [MIT](LICENSE.md) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescriptionRemarksExample
target_idstringdefines the id of the container element that will contain the link/button showing / hiding filters row (default - null) +var tfConfig = { + extensions: [{ + name: 'filtersVisibility' + target_id: 'my_container_id' + }] +}; +
enable_iconbooleanenable/disable default icon placed just before the link (default - true) +var tfConfig = { + extensions: [{ + name: 'filtersVisibility' + target_id: 'my_container_id', + enable_icon: false + }] +}; +
btn_textstringsets the text of the link showing / hiding filters row (default - '') +var tfConfig = { + extensions: [{ + name: 'filtersVisibility' + target_id: 'my_container_id', + enable_icon: false, + btn_text: 'Filters' + }] +}; +
btn_filters_row_visibility_htmlstringdefines the HTML of the button showing / hiding filters row (default +* null) note that the + + onclick event is added automatically +to the html element and overwrites any eventual + + onclick +attribute + + + var tfConfig = { btn_filters_row_visibility_html: '<button +class="myCssClass">Expand/collapse filters</button>' +} +
btn_filters_row_visibility_css_classstringdefines the css class of the link showing / hiding filters row (default +* 'btnExpClpFlt') + var tfConfig = { btn_filters_row_visibility_css_class: 'myClass' +} +
filters_row_visibility_css_classstringdefines the css class of the container (default - 'expClpFlt') + var tfConfig = { filters_row_visibility_css_class: 'myClass' +} +
filters_row_visibility_filters_tablestringIf filters are in a separated table, this is the id of the filters +table (default - null) + var tfConfig = { filters_row_visibility_filters_table: 'myTableId' +} +
filters_row_visibility_filters_indexnumberOnly with external filters, this tells the scripts which row contains +the filters (default - 1) + var tfConfig = { filters_row_visibility_filters_index: 1 } +
filters_row_visibility_at_startbooleanif set false it will hide the filters row at extension first load + var tfConfig = { filters_row_visibility_at_start: false } +
on_before_filters_row_is_displayedfunctioncalls defined function before filters row is displayed + var tfConfig = { on_before_filters_row_is_displayed: function(o){ +alert(o.id); } +
on_after_filters_row_is_displayedfunctioncalls defined function after filters row is displayed + var tfConfig = { on_after_filters_row_is_displayed: function(o){ +alert(o.id); } +
on_before_filters_row_is_hiddenfunctioncalls defined function before filters row is hidden + var tfConfig = { on_before_filters_row_is_hidden: function(o){ +alert(o.id); } +
on_after_filters_row_is_hiddenfunctioncalls defined function after filters row is hidden + var tfConfig = { on_after_filters_row_is_hidden: function(o){ +alert(o.id); } +
+ +