MeasuresBuilder

Builder de mesures pour ajouter, modifier et supprimer la configuration des mesures. Les mesures sont des champs numériques, par exemple les ventes, le profit ou la quantité

Méthodes

constructor

Définition:

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

Paramètres:

ParamètreTypeDescription
docY.Doc-
dslY.Map-

add

Ajouter une mesure

Définition:

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

Retour: MeasuresBuilder

Paramètres:

ParamètreTypeDescription
fieldstring- Nom du champ
callback(node: MeasureNodeBuilder) => void- Fonction de rappel

remove

Supprimer la mesure avec l'ID indiqué

Définition:

remove(id: string): MeasuresBuilder

Retour: MeasuresBuilder

Paramètres:

ParamètreTypeDescription
idstring- ID de mesure

update

Mettre à jour la configuration de mesure

Définition:

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

Retour: MeasuresBuilder

Paramètres:

ParamètreTypeDescription
idstring- ID de mesure
callback(node: MeasureNodeBuilder) => void- Fonction de rappel

find

Trouver la première mesure selon une condition de callback, comme Array.find

Définition:

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

Retour: MeasureNodeBuilder \| undefined

Paramètres:

ParamètreTypeDescription
predicate(node: MeasureNodeBuilder, index: number) => boolean- Condition de recherche

findAll

Obtenir toutes les mesures

Définition:

findAll(): MeasureNodeBuilder[]

Retour: MeasureNodeBuilder[]

toJSON

Exporter toutes les mesures en tableau JSON

Définition:

toJSON(): VBIMeasure[]

Retour: VBIMeasure[]

observe

Observer les changements de mesures

Définition:

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

Retour: () => void

Paramètres:

ParamètreTypeDescription
callbackObserveDeepCallback- Fonction de rappel

static isMeasureNode

Définition:

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

Retour: node is VBIMeasure

Paramètres:

ParamètreTypeDescription
nodeVBIMeasureTree[0]-

static isMeasureGroup

Définition:

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

Retour: node is VBIMeasureGroup

Paramètres:

ParamètreTypeDescription
nodeVBIMeasureTree[0]-