Skip to main content

maxField()

Last updated 2/10/2024

The

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

Available

Client

Function Signature
maxField(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 maximum value for the field in a set of records.

Examples

maxField()