DimensionsBuilder

Dimensions-Builder zum Hinzufügen, Ändern und Entfernen von Dimensionskonfigurationen. Dimensionen sind kategoriale Datenfelder wie Zeit, Region oder Produktkategorie

Methoden

constructor

Definition:

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

Parameter:

ParameterTypBeschreibung
docY.Doc-
dslY.Map-

add

Eine Dimension hinzufügen

Definition:

add(field: string, callback: (node: DimensionNodeBuilder) => void): DimensionsBuilder

Rückgabe: DimensionsBuilder

Parameter:

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

remove

Dimension mit angegebener ID entfernen

Definition:

remove(id: string): DimensionsBuilder

Rückgabe: DimensionsBuilder

Parameter:

ParameterTypBeschreibung
idstring- Dimensions-ID

update

Konfiguration der Dimension mit angegebener ID aktualisieren

Definition:

update(id: string, callback: (node: DimensionNodeBuilder) => void): DimensionsBuilder

Rückgabe: DimensionsBuilder

Parameter:

ParameterTypBeschreibung
idstring- Dimensions-ID
callback(node: DimensionNodeBuilder) => void- Callback-Funktion

find

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

Definition:

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

Rückgabe: DimensionNodeBuilder \| undefined

Parameter:

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

findAll

Alle Dimensionen abrufen

Definition:

findAll(): DimensionNodeBuilder[]

Rückgabe: DimensionNodeBuilder[]

toJSON

Alle Dimensionen als JSON-Array exportieren

Definition:

toJSON(): VBIDimension[]

Rückgabe: VBIDimension[]

observe

Dimensionsänderungen beobachten und eine Funktion zum Abbestellen zurückgeben

Definition:

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

Rückgabe: () => void

Parameter:

ParameterTypBeschreibung
callbackObserveDeepCallback- Callback-Funktion

static isDimensionNode

Definition:

static isDimensionNode(node: VBIDimensionTree[0]): node is VBIDimension

Rückgabe: node is VBIDimension

Parameter:

ParameterTypBeschreibung
nodeVBIDimensionTree[0]-

static isDimensionGroup

Definition:

static isDimensionGroup(node: VBIDimensionTree[0]): node is VBIDimensionGroup

Rückgabe: node is VBIDimensionGroup

Parameter:

ParameterTypBeschreibung
nodeVBIDimensionTree[0]-