Skip to main content

sumField()

Last updated 3/10/2024

The

sumField()
is a function on the
Five
object that returns the sum of all the values from the array of records associated to the field ID. The
sumField()
only works with a field that has a number data type.

Available

Client

Function Signature
sumField(records:Array<FiveRecord>, fieldID: string) : number;

ParameterTypeDescription
records
ArrayAn array of records
fieldID
stringA string representing the field ID

Return Value

A number representing the sum of all the values for the field in a set of records.

Examples

sumField()