DkGridFilter
You can access this instance through the property named filter of the DkGridComponent.
Generics
<T> represents the object's shape coming from the data source.
Properties
filterables
It is a read-only property that returns all the defined filterables.
Type:
Map<string, DkFilterable<T>>.
Methods
clearFilter()
It removes all conditions from filterables.
Params: None.
Return: void.
isFilterApplied()
It evaluates if the DkGrid instance has one filter condition applied, at least.
Params: None.
Return: boolean.
getFilteredRows()
It returns all rows that meet the filter conditions criteria.
Params: None.
Return: DkGridDataRowEntry<T>[].
Events
registerFilterableChange
It emits when you define a column as filterable. Then, the DkGrid instance will add the column to the internal Map named filterables.
Params: None.
Return: Observable<DkFilterable<T>>.
deregisterFilterableChange
It emits when you make a column not filterable when it was filterable. Then, the DkGrid instance will remove the column to the internal Map named filterables.
Params: None.
Return: Observable<DkFilterable<T>>.
filterChange
It emits when the user has defined/changed a filter condition.
Params: None.
Return: Observable<DkFilterable<T>>.
editionFilterChange
It emits when the user has defined/changed an edition filter condition.
Params: None.
Return: Observable<DkFilterable<T>>.
clearFilterChange
It emits after the DkGrid instance has removed all the filter conditions.
Params: None.
Return: Observable<void>.
clearEditionFilterChange
It emits after the DkGrid instance has removed all the filter conditions from the edition filterables.
Params: None.
Return: Observable<void>.
Last updated