PoPMeasureBuilder
Builder for period-over-period measures.
Do not instantiate this builder directly, instead use newPopMeasure().
export declare class PoPMeasureBuilder extends MeasureBuilderBase<IPoPMeasureDefinition>
Extends: MeasureBuilderBase<IPoPMeasureDefinition>
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 PoPMeasureBuilder class.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(measureOrLocalId: MeasureOrLocalId) => this | Sets master measure from which this period-over-period measure should be calculated. | ||
(popAttrIdOrRef: ObjRef | Identifier) => this | Sets period-over-period date dimension attribute to use for offsetting. For convenience the attribute may be specified by either object reference or as a string - in which case it is assumed this is identifier of the attribute object. |
Methods
Method | Modifiers | Description |
|---|---|---|
| ||
|
Property details
PoPMeasureBuilder.masterMeasureproperty
Sets master measure from which this period-over-period measure should be calculated.
masterMeasure: (measureOrLocalId: MeasureOrLocalId) => this;
PoPMeasureBuilder.popAttributeproperty
Sets period-over-period date dimension attribute to use for offsetting. For convenience the attribute may be specified by either object reference or as a string - in which case it is assumed this is identifier of the attribute object.
popAttribute: (popAttrIdOrRef: ObjRef | Identifier) => this;
Method details
PoPMeasureBuilder.buildDefinition()method
protected buildDefinition(): IPoPMeasureDefinition;
Returns
PoPMeasureBuilder.generateLocalId()method
protected generateLocalId(): string;
Returns
string