File

lists/src/filter2/current_filters.ts

Description

Represents all currently active filter predicates. Only filter predicates that are serialized into the search field are maintained here, the list of currently active filters will only be updated once after a refresh has been handled.

Index

Properties
Methods
Accessors

Constructor

constructor(applyFn: (filters: FilteredColumn[]) => void)
Parameters :
Name Type Optional
applyFn function No

Properties

all
all: FilteredColumn[]
Type : FilteredColumn[]
Default value : []

All currently active column filters.

Methods

applyPredicates
applyPredicates(column: ColumnFilter, predicates: FilterPredicate[])

Modifies the current filter predicates such that any previous predicates for the column are cleared, and the newly provided ones are added. Doing so causes the list to refresh.

Parameters :
Name Type Optional
column ColumnFilter No
predicates FilterPredicate[] No
Returns : void
clear
clear()

Clears all filters and refreshes the list.

Returns : void
clearColumn
clearColumn(column: ColumnFilter)

Clears all filter predicates for a given column, causing the list to refresh.

Parameters :
Name Type Optional
column ColumnFilter No
Returns : void
forColumn
forColumn(column: ColumnFilter)

Accesses all filter predicates for a given column.

Parameters :
Name Type Optional
column ColumnFilter No
Returns : FilterPredicate[]
isColumnFiltered
isColumnFiltered(column: ColumnFilter)

Determines whether the column currently has any filter predicates.

Parameters :
Name Type Optional
column ColumnFilter No
Returns : boolean

Accessors

updated$
getupdated$()

Emits a signal, the instance itself, when the current filters are updated.

Returns : Observable<>

result-matching ""

    No results matching ""