WhereFilterBuilder

Where フィルタービルダー。行レベルのフィルター条件の追加、変更、削除に使います。Where フィルターはデータクエリ前に有効になり、元データを絞り込みます

メソッド

constructor

定義:

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

パラメータ:

パラメータ説明
docY.Doc-
dslY.Map-

getConditions

定義:

getConditions(): Y.Array<any>

戻り値: Y.Array<any>

add

Where フィルター条件を追加

定義:

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

戻り値: WhereFilterBuilder

パラメータ:

パラメータ説明
fieldstring- フィールド名
callback(node: WhereFilterNodeBuilder) => void- コールバック関数

addGroup

Where グループを追加

定義:

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

戻り値: WhereFilterBuilder

パラメータ:

パラメータ説明
op'and' | 'or'- 論理演算子
callback(group: WhereGroupBuilder) => void- コールバック関数

update

指定 ID のフィルター条件を更新

定義:

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

戻り値: WhereFilterBuilder

パラメータ:

パラメータ説明
idstring- フィルター条件 ID
callback(node: WhereFilterNodeBuilder) => void- コールバック関数

updateGroup

指定 ID のグループを更新

定義:

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

戻り値: WhereFilterBuilder

パラメータ:

パラメータ説明
idstring- グループ ID
callback(group: WhereGroupBuilder) => void- コールバック関数

remove

指定 ID の条件または指定インデックスの項目を削除

定義:

remove(idOrIndex: string | number): WhereFilterBuilder

戻り値: WhereFilterBuilder

パラメータ:

パラメータ説明
idOrIndexstring | number- ID またはインデックス

find

コールバック条件に一致する最初の条件(フィルターまたはグループ)を検索。動作は Array.find と同じ

定義:

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

戻り値: WhereFilterNodeBuilder \| WhereGroupBuilder \| undefined

パラメータ:

パラメータ説明
predicate(entry: WhereFilterNodeBuilder | WhereGroupBuilder, index: number) => boolean- 検索条件

clear

すべての Where フィルター条件をクリア

定義:

clear()

toJSON

完全な Where フィルター設定をエクスポート

定義:

toJSON(): VBIWhereGroup

戻り値: VBIWhereGroup

observe

フィルター条件の変更を監視し、監視解除関数を返す

定義:

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

戻り値: () => void

パラメータ:

パラメータ説明
callbackObserveDeepCallback- コールバック関数

static isGroup

グループノードかどうかを判定

定義:

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

戻り値: boolean

パラメータ:

パラメータ説明
yMapY.Map-

static isNode

リーフノードかどうかを判定

定義:

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

戻り値: boolean

パラメータ:

パラメータ説明
yMapY.Map-