Angular DataGrid - Summary

Specifies the properties of the grid summary.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"

calculateCustomSummary

Specifies a custom aggregate function. This function is called for summary items whose summaryType is "custom".

Type:

Function

Function parameters:
options:

Object

Summary information.

Object structure:
Name Type Description
component

DataGrid

The UI component's instance.
groupIndex

Number

A zero-based group level. Available only when calculating group summary items.
name

String

The summary item's name.
summaryProcess

String

Indicates the stage of the summary item calculation; equals "start", "calculate" or "finalize".
totalValue any

The resulting summary item's value.
value any

A column value used to calculate the summary. If you need an entire data object in this field, do not specify the summary item's column property. To display the summary in this case, use the showInColumn property instead.

groupItems

Specifies items of the group summary.

Type:

Array<Object>

Default Value: undefined

recalculateWhileEditing

Specifies whether to recalculate summaries while a user edits data.

Type:

Boolean

Default Value: false

skipEmptyValues

Specifies whether to skip empty strings, null and undefined values when calculating a summary. Does not apply when you use a remote data source.

Type:

Boolean

Default Value: true

texts

Contains properties that specify text patterns for summary items.

Type:

Object

totalItems

Specifies items of the total summary.

Type:

Array<Object>

Default Value: undefined