File

lists/src/filter/filter.ts

Index

Properties
Methods
Accessors

Constructor

constructor(querying: BlueriqQuerying, session: BlueriqSession, table: Table)
Parameters :
Name Type Optional
querying BlueriqQuerying No
session BlueriqSession No
table Table No

Properties

currentColumns
Type : ColumnFilter[]

All currently available columns to filter on.

currentFilters
Type : FilteredColumn[]

All currently active column filters.

Methods

apply
apply(filters: FilteredColumn[])

Applies the new set of filters and triggers a refresh.

Parameters :
Name Type Optional
filters FilteredColumn[] No
Returns : void
applyColumn
applyColumn(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<>

results matching ""

    No results matching ""