#MeasureNodeBuilder

Measure node builder for configuring a single measure.

#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(): VBIMeasure['encoding'] | undefined

Returns: VBIMeasure['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<VBIMeasure['encoding']>): this

Returns: this

Parameters:

#setSort

Sets the sort configuration.

Definition:

setSort(sort: VBISort): this

Returns: this

Parameters:

#setAggregate

Sets the aggregate function.

Definition:

setAggregate(aggregate: VBIMeasure['aggregate']): this

Returns: this

Parameters:

#setFormat

Sets the number format.

Definition:

setFormat(format: VBIMeasureFormat): this

Returns: this

Parameters:

#getFormat

Gets the number format.

Definition:

getFormat(): VBIMeasureFormat | undefined

Returns: VBIMeasureFormat \| undefined

#clearFormat

Clears the number format configuration.

Definition:

clearFormat(): this

Returns: this

#clearSort

Clears the sort configuration.

Definition:

clearSort(): this

Returns: this

#toJSON

Exports to JSON.

Definition:

toJSON(): VBIMeasure

Returns: VBIMeasure