This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Refines a WixDataAggregate
to contain the sum from each aggregation group.
The sum()
method refines a WixDataAggregate
to contain the sum of the
values from the specified field for each aggregated group or from the
whole collection if no group is defined.
When the aggregation is run()
, the returned WixDataAggregateResult
object contains an item for each group with the following key:value pairs:
projectedField
, the key is named
using that value. Otherwise, the key is named using the following format:
"fieldSum"
, where field
is the name of the specified field.Sums can only be calculated on fields of type Number.
Note: Aggregations can only be used on collections you have created. They cannot be used on Wix app collections.
Field in which to find the sum.
Name of the field in the aggregation results containing the sum.