newPreviousPeriodMeasure()

Home > @gooddata/sdk-model > newPreviousPeriodMeasure

newPreviousPeriodMeasure() function

Creates a new Previous Period measure with the specified measure identifier and date data sets and optional modifications and localIdentifier.

Signature:

export declare function newPreviousPeriodMeasure(measureIdOrLocalId: MeasureOrLocalId, dateDataSets: IPreviousPeriodDateDataSetSimple[], modifications?: MeasureModifications<PreviousPeriodMeasureBuilder>): IMeasure<IPreviousPeriodMeasureDefinition>;

Parameters

Parameter	Type	Description
measureIdOrLocalId	MeasureOrLocalId	measure or local identifier of the measure to create Previous Period measure for
dateDataSets	IPreviousPeriodDateDataSetSimple[]	date data sets to use in the Previous Period calculation
modifications	MeasureModifications<PreviousPeriodMeasureBuilder>	(Optional) optional modifications (e.g. alias, title, etc.)

Returns:

IMeasure<IPreviousPeriodMeasureDefinition>