#WhereFilterBuilder

Where filter builder for adding, modifying, and removing row-level filter conditions. Where filters take effect before data querying and are used to filter raw data.

#Methods

#constructor

Definition:

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

Parameters:

#getConditions

Definition:

getConditions(): Y.Array<any>

Returns: Y.Array<any>

#add

Adds a Where filter condition.

Definition:

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

Returns: WhereFilterBuilder

Parameters:

#addGroup

Adds a Where group.

Definition:

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

Returns: WhereFilterBuilder

Parameters:

#update

Updates the filter condition with the specified ID.

Definition:

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

Returns: WhereFilterBuilder

Parameters:

#updateGroup

Updates the group with the specified ID.

Definition:

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

Returns: WhereFilterBuilder

Parameters:

#remove

Removes the condition with the specified ID or the item at the specified index.

Definition:

remove(idOrIndex: string | number): WhereFilterBuilder

Returns: WhereFilterBuilder

Parameters:

#find

Finds the first condition (filter or group) matching the callback condition, behaves like Array.find.

Definition:

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

Returns: WhereFilterNodeBuilder \| WhereGroupBuilder \| undefined

Parameters:

#clear

Clears all Where filter conditions.

Definition:

clear()

#toJSON

Exports the complete Where filter configuration.

Definition:

toJSON(): VBIWhereGroup

Returns: VBIWhereGroup

#observe

Listens for filter condition changes, returns an unsubscribe function.

Definition:

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

Returns: () => void

Parameters:

#static isGroup

Determines whether the node is a group node.

Definition:

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

Returns: boolean

Parameters:

#static isNode

Determines whether the node is a leaf node.

Definition:

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

Returns: boolean

Parameters: