WhereFilterNodeBuilder

Where filter node builder for configuring a single Where filter condition.

Properties

Methods

constructor

Definition:

constructor(yMap: Y.Map<any>)

Parameters:

ParameterTypeDescription
yMapY.Map-

getId

Gets the node ID.

Definition:

getId(): string

Returns: string

getField

Gets the field name.

Definition:

getField(): string

Returns: string

setField

Sets the field name.

Definition:

setField(field: string): this

Returns: this

Parameters:

ParameterTypeDescription
fieldstring- Field name

getOperator

Gets the filter operator.

Definition:

getOperator(): string | undefined

Returns: string \| undefined

setOperator

Sets the filter operator.

Definition:

setOperator(operator: string): this

Returns: this

Parameters:

ParameterTypeDescription
operatorstring- Operator

setValue

Sets the filter value.

Definition:

setValue(value: unknown): this

Returns: this

Parameters:

ParameterTypeDescription
valueunknown- Filter value

setDate

Sets the date filter condition.

Definition:

setDate(predicate: VBIWhereDatePredicate): this

Returns: this

Parameters:

ParameterTypeDescription
predicateVBIWhereDatePredicate- Date predicate

getDate

Gets the date filter condition; returns undefined for non-date filters.

Definition:

getDate(): VBIWhereDatePredicate | undefined

Returns: VBIWhereDatePredicate \| undefined

toJSON

Exports to JSON.

Definition:

toJSON(): VBIWhereFilter

Returns: VBIWhereFilter