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]-