Description
Spreads numerical values on a certain number of items on any ordered Dimension.
Syntax
SPREAD(Source Block, Ranking Dimension, Spread Number [, Starting Index])
-
Source Block
- can be a List or a Metric that must be a number or integer data type. -
Ranking Dimension
- this is a dimension from the Source Block that you want to spread the numbers across -
Spread Number
- defines how many items to split the total across. This needs to be an integer. -
Starting Index
- defines a starting point of each spread, that is to say a List Property or a Metric using a subset of the Source Block dimensions and of type the Ranking Dimension.
Return type
number
Examples
Case | Results | Return Type |
| split the |
|
| split the |
|
| set |
|
| each |
|
SPREAD('Employee Start Bonus',Month,3,'Employee Start Date') | each Employee will receive a Start Bonus stored in the Metric Employee Start Bonus and split over the next 3 month after their Employee Start Date . | number |
Excel equivalent: None