lists/src/filter/filter.ts
Properties |
Methods |
constructor(querying: BlueriqQuerying, session: BlueriqSession, table: Table)
|
||||||||||||
|
Parameters :
|
| filterOptions |
filterOptions:
|
Type : FilterOption[]
|
Default value : []
|
| filterValues |
filterValues:
|
Type : FilterValue[]
|
Default value : []
|
| searchField |
searchField:
|
Type : Field
|
Decorators :
@BlueriqChild(Field)
|
| addFilter | ||||||||
addFilter(filterValue: FilterValue)
|
||||||||
|
Adds a filter to the list of filters, only if the filter is valid and if it does not yet exist in the list of filters.
Parameters :
Returns :
boolean
boolean indicating whether adding the filter succeeded or not |
| applyFilters |
applyFilters()
|
|
Applies the list of filters by submitting the search field with the filters contents, only if filters exist.
Returns :
void
|
| clearFilters |
clearFilters()
|
|
Clears the list of filters and submits the search field to the backend so the list data is retrieved without filters.
Returns :
void
|
| removeFilter | ||||||||
removeFilter(filterValue: FilterValue)
|
||||||||
|
Removes a filter from the list of filters, if it can be found in the list.
Parameters :
Returns :
boolean
boolean indicating whether the filter was successfully removed or not (in case it was not found) |