WhereFilterBuilder

Where-Filter-Builder zum Hinzufügen, Ändern und Entfernen von Filterbedingungen auf Zeilenebene. Where-Filter wirken vor der Datenabfrage und filtern Rohdaten

Methoden

constructor

Definition:

constructor(doc: Y.Doc, dsl: Y.Map<any>)

Parameter:

ParameterTypBeschreibung
docY.Doc-
dslY.Map-

getConditions

Definition:

getConditions(): Y.Array<any>

Rückgabe: Y.Array<any>

add

Eine Where-Filterbedingung hinzufügen

Definition:

add(field: string, callback: (node: WhereFilterNodeBuilder) => void): WhereFilterBuilder

Rückgabe: WhereFilterBuilder

Parameter:

ParameterTypBeschreibung
fieldstring- Feldname
callback(node: WhereFilterNodeBuilder) => void- Callback-Funktion

addGroup

Eine Where-Gruppe hinzufügen

Definition:

addGroup(op: 'and' | 'or', callback: (group: WhereGroupBuilder) => void): WhereFilterBuilder

Rückgabe: WhereFilterBuilder

Parameter:

ParameterTypBeschreibung
op'and' | 'or'- Logischer Operator
callback(group: WhereGroupBuilder) => void- Callback-Funktion

update

Filterbedingung mit angegebener ID aktualisieren

Definition:

update(id: string, callback: (node: WhereFilterNodeBuilder) => void): WhereFilterBuilder

Rückgabe: WhereFilterBuilder

Parameter:

ParameterTypBeschreibung
idstring- Filterbedingungs-ID
callback(node: WhereFilterNodeBuilder) => void- Callback-Funktion

updateGroup

Gruppe mit angegebener ID aktualisieren

Definition:

updateGroup(id: string, callback: (group: WhereGroupBuilder) => void): WhereFilterBuilder

Rückgabe: WhereFilterBuilder

Parameter:

ParameterTypBeschreibung
idstring- Gruppen-ID
callback(group: WhereGroupBuilder) => void- Callback-Funktion

remove

Bedingung mit angegebener ID oder Element an angegebenem Index entfernen

Definition:

remove(idOrIndex: string | number): WhereFilterBuilder

Rückgabe: WhereFilterBuilder

Parameter:

ParameterTypBeschreibung
idOrIndexstring | number- ID oder Index

find

Erste Bedingung (Filter oder Gruppe) nach Callback-Bedingung finden, Verhalten wie Array.find

Definition:

find(predicate: (entry: WhereFilterNodeBuilder | WhereGroupBuilder, index: number) => boolean): WhereFilterNodeBuilder | WhereGroupBuilder | undefined

Rückgabe: WhereFilterNodeBuilder \| WhereGroupBuilder \| undefined

Parameter:

ParameterTypBeschreibung
predicate(entry: WhereFilterNodeBuilder | WhereGroupBuilder, index: number) => boolean- Suchbedingung

clear

Alle Where-Filterbedingungen leeren

Definition:

clear()

toJSON

Vollständige Where-Filterkonfiguration exportieren

Definition:

toJSON(): VBIWhereGroup

Rückgabe: VBIWhereGroup

observe

Filterbedingungsänderungen beobachten und eine Funktion zum Abbestellen zurückgeben

Definition:

observe(callback: ObserveDeepCallback): () => void

Rückgabe: () => void

Parameter:

ParameterTypBeschreibung
callbackObserveDeepCallback- Callback-Funktion

static isGroup

Prüfen, ob der Knoten ein Gruppenknoten ist

Definition:

static isGroup(yMap: Y.Map<any>): boolean

Rückgabe: boolean

Parameter:

ParameterTypBeschreibung
yMapY.Map-

static isNode

Prüfen, ob der Knoten ein Blattknoten ist

Definition:

static isNode(yMap: Y.Map<any>): boolean

Rückgabe: boolean

Parameter:

ParameterTypBeschreibung
yMapY.Map-