modifyPreviousPeriodMeasure()

Home > @gooddata/sdk-model > modifyPreviousPeriodMeasure

modifyPreviousPeriodMeasure() function

Creates a new Previous Period measure by applying modifications on top of an existing measure.

Signature:

export declare function modifyPreviousPeriodMeasure(measure: IMeasure<IPreviousPeriodMeasureDefinition>, modifications?: MeasureModifications<PreviousPeriodMeasureBuilder>): IMeasure<IPreviousPeriodMeasureDefinition>;

Parameters

Parameter	Type	Description
measure	IMeasure<IPreviousPeriodMeasureDefinition>	measure to use as template for the new measure
modifications	MeasureModifications<PreviousPeriodMeasureBuilder>	(Optional) modifications to apply

Returns:

IMeasure<IPreviousPeriodMeasureDefinition>

new instance

Remarks

This operation is immutable and will not alter the input measure.

The returned measure will have the same localIdentifier as the original measure. If you would like to assign new/different local identifier to the measure, you can do that using the modifications where you can provide either new custom localId or indicate that the measure should fall back to the auto-generated localId.