#DimensionNodeBuilder

Dimension node builder for configuring a single dimension.

#Methods

#constructor

Definition:

constructor(yMap: Y.Map<any>)

Parameters:

#getId

Gets the node ID.

Definition:

getId(): string

Returns: string

#getField

Gets the field name.

Definition:

getField(): string

Returns: string

#getEncoding

Gets the chart encoding position.

Definition:

getEncoding(): VBIDimension['encoding'] | undefined

Returns: VBIDimension['encoding'] \| undefined

#getSort

Gets the sort configuration.

Definition:

getSort(): VBISort | undefined

Returns: VBISort \| undefined

#setAlias

Sets the display name.

Definition:

setAlias(alias: string): this

Returns: this

Parameters:

#setEncoding

Sets the chart encoding position.

Definition:

setEncoding(encoding: NonNullable<VBIDimension['encoding']>): this

Returns: this

Parameters:

#setSort

Sets the sort configuration.

Definition:

setSort(sort: VBISort): this

Returns: this

Parameters:

#setAggregate

Sets the date aggregation function.

Definition:

setAggregate(aggregate: NonNullable<VBIDimension['aggregate']>): this

Returns: this

Parameters:

#clearAggregate

Clears the date aggregation function.

Definition:

clearAggregate(): this

Returns: this

#clearSort

Clears the sort configuration.

Definition:

clearSort(): this

Returns: this

#toJSON

Exports to JSON.

Definition:

toJSON(): VBIDimension

Returns: VBIDimension