Aggregate Property

The Aggregate property sets or returns the type of relative time category.

Syntax

SpecialCategory .Aggregate

Applies To

SpecialCategory Object

Discussion

Use this property to customize a category that you can then use to track measures for specific periods of time relative to the current time. Relative time categories can specify

  • a single period, to show changes from one time period to another
  • a sequential set of periods to show to-date totals that compare current performance to past performance
  • a relative time period to show running totals, for example, a six-month period before the current date

The Aggregate property uses the values of xtrTimeAggregate.

The properties in the following example specify a running total category that spans the six months leading up to the current month, for this year and last year. 

Aggregate = trAggregateRunningGrouped
ContextLevel = "Year"
ContextOffset = -1
RunningPeriods = 6
TargetLevel = "Month"
TargetOffset = 0

Type

Constant - xtrTimeAggregate

Access

Read/Write

Examples

objSpecCategory 
= _    objModel.Dimensions("Time").Categories.
	Add(xtrObjectType.trSpecialCategory)objSpecCategory.Aggregate
= xtrTimeAggregate.trAggregateRunning