File

lists/src/filter/types.ts

Description

Represents the filter information of a single column.

Index

Properties
Methods

Methods

apply
apply(predicates: FilterPredicate[])

Applies the provided filter predicates to this column.

Parameters :
Name Type Optional Description
predicates FilterPredicate[] No

The filter predicates to apply.

Returns : void
clear
clear()

Clears all filter predicates for this column.

Returns : void

Properties

domain
domain: Domain
Type : Domain

If this filter is of 'domain' type, this represents the domain with all available filter options.

isActive
isActive: boolean
Type : boolean

Returns whether or not this column is currently being filtered.

isActive$
isActive$: Observable<boolean>
Type : Observable<boolean>

Represents a stream that emits when the column's filter becomes active or inactive.

labels
labels: literal type
Type : literal type

Represents the labels that may be used for internationalization.

predicates
predicates: FilterPredicate[]
Type : FilterPredicate[]

Returns the currently applied filter predicates for this column.

title
title: string
Type : string

Represents the title text for this filter.

type
type: "boolean" | "date" | "datetime" | "domain" | "integer" | "number" | "currency" | "percentage" | "text"
Type : "boolean" | "date" | "datetime" | "domain" | "integer" | "number" | "currency" | "percentage" | "text"

Represents the type of filter that can be applied.

updated$
updated$: Observable<>
Type : Observable<>

Represents a stream that emits a signal, the instance itself, when the column's filter predicates may have been updated. It is not accurately determined if an updated set of filter predicates actually affects this column, so this stream may emit even when none of the column's actually changed.

results matching ""

    No results matching ""