VisActor VBI
  • 日本語

      • MeasuresBuilder

      メジャービルダー。メジャー設定の追加、変更、削除に使います。メジャーは売上、利益、数量など、データの数値フィールドです

      メソッド

      constructor

      定義:

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

      パラメータ:

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

      add

      メジャーを追加

      定義:

      add(field: string, callback: (node: MeasureNodeBuilder) => void): MeasuresBuilder

      戻り値: MeasuresBuilder

      パラメータ:

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

      remove

      指定 ID のメジャーを削除

      定義:

      remove(id: string): MeasuresBuilder

      戻り値: MeasuresBuilder

      パラメータ:

      パラメータ型説明
      idstring- メジャー ID

      update

      メジャー設定を更新

      定義:

      update(id: string, callback: (node: MeasureNodeBuilder) => void): MeasuresBuilder

      戻り値: MeasuresBuilder

      パラメータ:

      パラメータ型説明
      idstring- メジャー ID
      callback(node: MeasureNodeBuilder) => void- コールバック関数

      find

      コールバック条件に一致する最初のメジャーを検索。動作は Array.find と同じ

      定義:

      find(predicate: (node: MeasureNodeBuilder, index: number) => boolean): MeasureNodeBuilder | undefined

      戻り値: MeasureNodeBuilder \| undefined

      パラメータ:

      パラメータ型説明
      predicate(node: MeasureNodeBuilder, index: number) => boolean- 検索条件

      findAll

      すべてのメジャーを取得

      定義:

      findAll(): MeasureNodeBuilder[]

      戻り値: MeasureNodeBuilder[]

      toJSON

      すべてのメジャーを JSON 配列としてエクスポート

      定義:

      toJSON(): VBIMeasure[]

      戻り値: VBIMeasure[]

      observe

      メジャー変更を監視

      定義:

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

      戻り値: () => void

      パラメータ:

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

      static isMeasureNode

      定義:

      static isMeasureNode(node: VBIMeasureTree[0]): node is VBIMeasure

      戻り値: node is VBIMeasure

      パラメータ:

      パラメータ型説明
      nodeVBIMeasureTree[0]-

      static isMeasureGroup

      定義:

      static isMeasureGroup(node: VBIMeasureTree[0]): node is VBIMeasureGroup

      戻り値: node is VBIMeasureGroup

      パラメータ:

      パラメータ型説明
      nodeVBIMeasureTree[0]-