Interface: IFilterable¶

This interface defines the filter/sorter. It has to be implemented by the controls using the filter action to display a filter modal page

Hierarchy¶

▸ getFilterCriteria(name: string, values: Array‹object›, isArrayFilterProperty?: boolean): FilterCriteria

Get defined filter criteria based on the name

deprecated - use getFilterCriteriaAsync

Parameters:

Name	Type	Description
`name`	string	the name of the criteria to find
`values`	Array‹object›	the values of the criteria to find
`isArrayFilterProperty?`	boolean	is the array type of criteria

Returns: FilterCriteria

return the filter criteria

▸ getFilterCriteriaAsync(name: string, values: Array‹object›, isArrayFilterProperty?: boolean): Promise‹[FilterCriteria, Array‹object›]›

Get defined filter criteria based on the name

Parameters:

Name	Type	Description
`name`	string	the name of the criteria to find
`values`	Array‹object›	the values of the criteria to find
`isArrayFilterProperty?`	boolean	is the array type of criteria

Returns: Promise‹[FilterCriteria, Array‹object›]›

return array [ the filter criteria, values of the criteria ]

▸ getSelectedValues(): Array‹FilterCriteria›

Returns: Array‹FilterCriteria›

return selected list of filter criteria

▸ getSorterCriteria(name: string): FilterCriteria

Get defined sorter criteria based on the name

Parameters:

Name	Type	Description
`name`	string	the name of the criteria to find

Returns: FilterCriteria

▸ setFilterResult(result: Array‹FilterCriteria›): any

Set filter result with list of defined criteria

Parameters:

Name	Type	Description
`result`	Array‹FilterCriteria›	the list of criteria for filter/sorter

Returns: any