#MeasuresBuilder

Measure builder for adding, modifying, and removing measure configuration. Measures are the numeric fields in data, such as: sales, profit, quantity.

#Methods

#constructor

Definition:

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

Parameters:

#add

Adds a measure.

Definition:

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

Returns: MeasuresBuilder

Parameters:

#remove

Removes the measure with the specified ID.

Definition:

remove(id: string): MeasuresBuilder

Returns: MeasuresBuilder

Parameters:

#update

Updates the measure configuration.

Definition:

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

Returns: MeasuresBuilder

Parameters:

#find

Finds the first measure matching the callback condition, behaves like Array.find.

Definition:

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

Returns: MeasureNodeBuilder \| undefined

Parameters:

#findAll

Gets all measures.

Definition:

findAll(): MeasureNodeBuilder[]

Returns: MeasureNodeBuilder[]

#toJSON

Exports all measures as a JSON array.

Definition:

toJSON(): VBIMeasure[]

Returns: VBIMeasure[]

#observe

Listens for measure changes.

Definition:

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

Returns: () => void

Parameters:

#static isMeasureNode

Definition:

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

Returns: node is VBIMeasure

Parameters:

#static isMeasureGroup

Definition:

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

Returns: node is VBIMeasureGroup

Parameters: