Package com.smartgwt.client.widgets.grid

# Interface SummaryFunction

public interface SummaryFunction
Function to produce a summary value based on an array of records and a field definition. An example usage is the listGrid summary row, where a row is shown at the bottom of the listGrid containing summary information about each column.

See Also:
  - `SummaryFunctionType`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Object`
  `getSummaryValue(Record[] records, ListGridField field)`
  Function to produce a summary value based on an array of records and a field definition.

- ## Method Details

  - ### getSummaryValue

    Object getSummaryValue(Record[] records, ListGridField field)
    Function to produce a summary value based on an array of records and a field definition.
    Parameters:
      `records` - the array of records
      `field` - the field definition for which the summary is required
    Returns:
      the summary value