NAME

JPList::Controls::Filter - JPList Filter controls

VERSION

Version 0.05

SYNOPSIS

with 'JPList::Controls::Filter'

DESCRIPTION

The Filter module allows you get the values filter controls

METHODS

textbox

Params : filter_vals

{
    'type' => 'textbox',
    'action' => 'filter',
    'inStorage' => $VAR1->[0]{'inStorage'},
    'data' => {
                'filterType' => 'TextFilter',
                'mode' => 'contains',
                'value' => '',
                'ignore' => '[~!@#$%^&*()+=`\'"/\\_]+',
                'path' => '.UserName'
              },
    'isAnimateToTop' => $VAR1->[0]{'isAnimateToTop'},
    'initialIndex' => 1,
    'inDeepLinking' => $VAR1->[0]{'inStorage'},
    'name' => 'username-filter',
    'inAnimation' => $VAR1->[0]{'inStorage'}
}

Returns: Returns the column and value for filter textbox

Desc : Returns the column and value for filter textbox

filterdropdown

Params : filter_vals

{
    'type' => 'filter-drop-down',
    'data' => {
                'filterType' => 'ColumnName',
                'path' => 'default'
              },
    'action' => 'filter',
    'isAnimateToTop' => $VAR1->[0]{'isAnimateToTop'},
    'initialIndex' => 5,
    'inDeepLinking' => $VAR1->[0]{'inDeepLinking'},
    'inAnimation' => $VAR1->[0]{'inDeepLinking'},
    'inStorage' => $VAR1->[0]{'inDeepLinking'},
    'name' => 'category-dropdown-filter'
}

Returns: Returns the column and value for filter dropdown

Desc : Returns the column and value for filter dropdown

filterselect

Params : filter_vals

{
    'isAnimateToTop' => $VAR1->[0]{'isAnimateToTop'},
    'data' => {
                'path' => '.Electric',
                'filterType' => 'path'
              },
    'inDeepLinking' => $VAR1->[0]{'inDeepLinking'},
    'action' => 'filter',
    'name' => 'ServiceType',
    'type' => 'filter-select',
    'inStorage' => $VAR1->[0]{'inDeepLinking'},
    'inAnimation' => $VAR1->[0]{'inDeepLinking'}
  }

Returns: Returns the column and value for filter select

Desc : Returns the column and value for filter select

filterdaterange

Params : filter_vals

{
    'data' => {
                'path' => '.FromDate',
                'next_day' => 14,
                'prev_year' => 2017,
                'next_month' => 5,
                'next_year' => 2017,
                'format' => '{month}/{day}/{year}',
                'filterType' => 'dateRange',
                'prev_month' => 5,
                'prev_day' => 6
              },
    'inDeepLinking' => $VAR1->[0]{'inAnimation'},
    'action' => 'filter',
    'inStorage' => $VAR1->[0]{'inAnimation'},
    'name' => 'FromDate',
    'type' => 'date-picker-range-filter',
    'isAnimateToTop' => $VAR1->[0]{'isAnimateToTop'},
    'inAnimation' => $VAR1->[0]{'inAnimation'}
  }

Returns: Returns the column and value for filter daterange

Desc : Returns the column and value for filter daterange

filterdatepicker

Params : filter_vals

{
    'inDeepLinking' => $VAR1->[0]{'inAnimation'},
    'inAnimation' => $VAR1->[0]{'inAnimation'},
    'isAnimateToTop' => $VAR1->[0]{'isAnimateToTop'},
    'action' => 'filter',
    'inStorage' => $VAR1->[0]{'inAnimation'},
    'type' => 'date-picker-filter',
    'data' => {
                'year' => 2017,
                'format' => '{month}/{day}/{year}',
                'filterType' => 'date',
                'day' => 10,
                'path' => '.ReadDate',
                'month' => 6
              },
    'name' => 'ReadDate'
}

Returns: Returns the column and value for filter daterange

Desc : Returns the column and value for filter daterange

checkboxgroup

Params : filter_vals

{
    'name' => 'SourceType',
    'action' => 'filter',
    'inStorage' => $VAR1->[0]{'inStorage'},
    'isAnimateToTop' => $VAR1->[0]{'isAnimateToTop'},
    'type' => 'checkbox-group-filter',
    'inAnimation' => $VAR1->[0]{'inStorage'},
    'data' => {
                'pathGroup' => [
                                 '.Schedule',
                                 '.Estimate'
                               ],
                'filterType' => 'pathGroup'
              },
    'inDeepLinking' => $VAR1->[0]{'inStorage'}
}

Returns: Returns the column and value for filter checkbox group

Desc : Returns the column and value for filter checkbox group

AUTHORS

Sheeju Alex, <sheeju@exceleron.com>

BUGS

https://github.com/sheeju/JPList/issues

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc JPList

You can also look for information at:

ACKNOWLEDGEMENTS

Development time supported by Exceleron www.exceleron.com.

LICENSE AND COPYRIGHT

Copyright (C) 2017 Exceleron Software, LLC

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.