The SPREAD function divides a value evenly over multiple entities.
Syntax
SPREAD(Value to divide, Entity count [, List])
Arguments
Argument | Data type | Description |
Value to divide | Number | The value to be spread across the entity count. |
Entity count | Number | The number of entities over which to spread the value. |
List (Polaris-only) | List | The list over which the function should operate. See Calculation engine functionality differences. |
The SPREAD function returns a number.
Calculation engine functionality differences
- In Polaris, you can't use the SPREAD function for line items that have the Formula summary method. In the Classic Engine, you can.
- In Polaris, you can use the SPREAD function over any dimension, by including an additional argument. In the Classic Engine, you can't. Where, if the additional argument isn't included, the function defaults to Time as the dimension.
Constraints
If you are operating over time, the Value to divide and Entity count arguments must have the same time range.
Excel equivalent
Examples
Jan 19 | Feb 19 | Mar 19 | Apr 19 | May 19 | Jun 19 | |
Value to spread | 1000 | 0 | 400 | 0 | 0 | 0 |
SPREAD(Value to spread, 4) | 250 | 250 | 350 | 350 | 100 | 100 |
From the example above, the value 1000 is entered into the Value to spread cell for Jan 19 and is spread over the next 4 months.
When an additional value of 400 is added for Mar 19, the value is also spread over the next 4 months. The overlapping months are summed up to provide a final figure.