#DimensionsBuilder

Dimension builder for adding, modifying, and removing dimension configuration. Dimensions are the categorical fields in data, such as: time, region, product category.

#Properties

#Methods

#constructor

Definition:

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

Parameters:

#add

Adds a dimension.

Definition:

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

Returns: DimensionsBuilder

Parameters:

#remove

Removes the dimension with the specified ID.

Definition:

remove(id: string): DimensionsBuilder

Returns: DimensionsBuilder

Parameters:

#update

Updates the configuration of the dimension with the specified ID.

Definition:

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

Returns: DimensionsBuilder

Parameters:

#find

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

Definition:

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

Returns: DimensionNodeBuilder \| undefined

Parameters:

#findAll

Gets all dimensions.

Definition:

findAll(): DimensionNodeBuilder[]

Returns: DimensionNodeBuilder[]

#toJSON

Exports all dimensions as a JSON array.

Definition:

toJSON(): VBIDimension[]

Returns: VBIDimension[]

#observe

Listens for dimension changes, returns an unsubscribe function.

Definition:

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

Returns: () => void

Parameters:

#static isDimensionNode

Definition:

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

Returns: node is VBIDimension

Parameters:

#static isDimensionGroup

Definition:

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

Returns: node is VBIDimensionGroup

Parameters: