@serenity-is/corelib / FilterStore

Class: FilterStore

Defined in: src/ui/filtering/filterstore.ts:7

Stores filter lines for a grid and builds criteria and display text from them.

Constructors

Constructor

new FilterStore(fields): FilterStore

Defined in: src/ui/filtering/filterstore.ts:14

Creates a filter store.

Parameters

fields

PropertyItem[]

The filterable fields.

Returns

FilterStore

Properties

[typeInfo]

static [typeInfo]: ClassTypeInfo<"Serenity.">

Defined in: src/ui/filtering/filterstore.ts:8

Methods

add_changed()

add_changed(listener): void

Defined in: src/ui/filtering/filterstore.ts:187

Subscribes a listener to store changes.

Parameters

listener

(store) => void

The listener.

Returns

void

---

get_activeCriteria()

get_activeCriteria(): any[]

Defined in: src/ui/filtering/filterstore.ts:203

Returns the active criteria for the current filter lines.

Returns

any[]

The criteria expression.

---

get_displayText()

get_displayText(): string

Defined in: src/ui/filtering/filterstore.ts:211

Returns the display text for the current filter lines.

Returns

string

The display text.

---

get_fieldByName()

get_fieldByName(): object

Defined in: src/ui/filtering/filterstore.ts:163

Returns the fields by name.

Returns

object

The field map.

---

get_fields()

get_fields(): PropertyItem[]

Defined in: src/ui/filtering/filterstore.ts:155

Returns the filterable fields.

Returns

PropertyItem[]

The fields.

---

get_items()

get_items(): FilterLine[]

Defined in: src/ui/filtering/filterstore.ts:171

Returns the filter lines.

Returns

FilterLine[]

The filter lines.

---

raiseChanged()

raiseChanged(): void

Defined in: src/ui/filtering/filterstore.ts:178

Notifies listeners that the store changed.

Returns

void

---

remove_changed()

remove_changed(listener): void

Defined in: src/ui/filtering/filterstore.ts:195

Unsubscribes a listener from store changes.

Parameters

listener

(store) => void

The listener.

Returns

void

---

getCriteriaFor()

static getCriteriaFor(items): any[]

Defined in: src/ui/filtering/filterstore.ts:53

Builds a criteria expression from a list of filter lines.

Parameters

items

FilterLine[]

The filter lines.

Returns

any[]

The criteria expression.

---

getDisplayTextFor()

static getDisplayTextFor(items): string

Defined in: src/ui/filtering/filterstore.ts:110

Builds the display text for a list of filter lines.

Parameters

items

FilterLine[]

The filter lines.

Returns

string

The display text.