MeasureBuilder

Home > @gooddata/sdk-model > MeasureBuilder

MeasureBuilder class

Builder for simple measures.

Do not instantiate this builder directly, instead use newMeasure() or modifyMeasure() functions.

Signature:

export declare class MeasureBuilder extends MeasureBuilderBase<IMeasureDefinition> 

Extends: MeasureBuilderBase<IMeasureDefinition>

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the MeasureBuilder class.

Properties

Property	Modifiers	Type	Description
aggregation		(aggregation?: MeasureAggregation | undefined) => this	Sets aggregation to use for measures created from facts.
defaultAggregation		() => this	Resets measure aggregation to the default (SUM).
filters		(...filters: IMeasureFilter[]) => this	Sets filters to apply when calculating the values of this measure.
measureItem		(ref: ObjRef) => this	Sets reference to measure item that will be used for calculation.
noFilters		() => this	Resets measure filters - this will remove all filters from the measure.
noRatio		() => this	Resets compute as ratio indicator.
ratio		(value?: boolean) => this	Indicates that the measure values should be calculated as percent contributions to the total unsliced value.

Methods

Method	Modifiers	Description
buildDefinition()	protected
generateLocalId()	protected