MeasuresBuilder

Kennzahlen-Builder zum Hinzufügen, Ändern und Entfernen von Kennzahlenkonfigurationen. Kennzahlen sind numerische Datenfelder wie Umsatz, Gewinn oder Menge

Methoden

constructor

Definition:

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

Parameter:

ParameterTypBeschreibung
docY.Doc-
dslY.Map-

add

Eine Kennzahl hinzufügen

Definition:

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

Rückgabe: MeasuresBuilder

Parameter:

ParameterTypBeschreibung
fieldstring- Feldname
callback(node: MeasureNodeBuilder) => void- Callback-Funktion

remove

Kennzahl mit angegebener ID entfernen

Definition:

remove(id: string): MeasuresBuilder

Rückgabe: MeasuresBuilder

Parameter:

ParameterTypBeschreibung
idstring- Kennzahlen-ID

update

Kennzahlenkonfiguration aktualisieren

Definition:

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

Rückgabe: MeasuresBuilder

Parameter:

ParameterTypBeschreibung
idstring- Kennzahlen-ID
callback(node: MeasureNodeBuilder) => void- Callback-Funktion

find

Erste Kennzahl nach Callback-Bedingung finden, Verhalten wie Array.find

Definition:

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

Rückgabe: MeasureNodeBuilder \| undefined

Parameter:

ParameterTypBeschreibung
predicate(node: MeasureNodeBuilder, index: number) => boolean- Suchbedingung

findAll

Alle Kennzahlen abrufen

Definition:

findAll(): MeasureNodeBuilder[]

Rückgabe: MeasureNodeBuilder[]

toJSON

Alle Kennzahlen als JSON-Array exportieren

Definition:

toJSON(): VBIMeasure[]

Rückgabe: VBIMeasure[]

observe

Kennzahlenänderungen beobachten

Definition:

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

Rückgabe: () => void

Parameter:

ParameterTypBeschreibung
callbackObserveDeepCallback- Callback-Funktion

static isMeasureNode

Definition:

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

Rückgabe: node is VBIMeasure

Parameter:

ParameterTypBeschreibung
nodeVBIMeasureTree[0]-

static isMeasureGroup

Definition:

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

Rückgabe: node is VBIMeasureGroup

Parameter:

ParameterTypBeschreibung
nodeVBIMeasureTree[0]-