DimensionsBuilder

Builder de dimensions pour ajouter, modifier et supprimer la configuration des dimensions. Les dimensions sont des champs catégoriels, par exemple le temps, la région ou la catégorie de produit

Méthodes

constructor

Définition:

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

Paramètres:

ParamètreTypeDescription
docY.Doc-
dslY.Map-

add

Ajouter une dimension

Définition:

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

Retour: DimensionsBuilder

Paramètres:

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

remove

Supprimer la dimension avec l'ID indiqué

Définition:

remove(id: string): DimensionsBuilder

Retour: DimensionsBuilder

Paramètres:

ParamètreTypeDescription
idstring- ID de dimension

update

Mettre à jour la configuration de la dimension avec l'ID indiqué

Définition:

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

Retour: DimensionsBuilder

Paramètres:

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

find

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

Définition:

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

Retour: DimensionNodeBuilder \| undefined

Paramètres:

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

findAll

Obtenir toutes les dimensions

Définition:

findAll(): DimensionNodeBuilder[]

Retour: DimensionNodeBuilder[]

toJSON

Exporter toutes les dimensions en tableau JSON

Définition:

toJSON(): VBIDimension[]

Retour: VBIDimension[]

observe

Observer les changements de dimensions et renvoyer une fonction de désabonnement

Définition:

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

Retour: () => void

Paramètres:

ParamètreTypeDescription
callbackObserveDeepCallback- Fonction de rappel

static isDimensionNode

Définition:

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

Retour: node is VBIDimension

Paramètres:

ParamètreTypeDescription
nodeVBIDimensionTree[0]-

static isDimensionGroup

Définition:

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

Retour: node is VBIDimensionGroup

Paramètres:

ParamètreTypeDescription
nodeVBIDimensionTree[0]-