Skip to content

Commit 58520ba

Browse files
DataGrid: Add summary column info (#7944) (#7960)
1 parent 6e9db1b commit 58520ba

File tree

2 files changed

+15
-4
lines changed

2 files changed

+15
-4
lines changed

api-reference/10 UI Components/dxDataGrid/1 Configuration/summary/calculateCustomSummary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Indicates the stage of the summary item calculation; equals *"start"*, *"calcula
2424
The resulting summary item's value.
2525

2626
##### field(options.value): any
27-
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](/api-reference/10%20UI%20Components/dxDataGrid/1%20Configuration/summary/totalItems/column.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/summary/totalItems/#column') property. To display the summary in this case, use the [showInColumn](/api-reference/10%20UI%20Components/dxDataGrid/1%20Configuration/summary/totalItems/showInColumn.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/summary/totalItems/#showInColumn') property instead.
27+
A cell value. If you do not specify **totalItems[]**.[column](/api-reference/10%20UI%20Components/dxDataGrid/1%20Configuration/summary/totalItems/column.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/summary/totalItems/#column'), the component passes row data objects to this field.
2828

2929
---
3030
This is a single function for all custom summary items. Specify a [name](/api-reference/10%20UI%20Components/dxDataGrid/1%20Configuration/summary/totalItems/name.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/summary/totalItems/#name') for each item to identify it in the function.

api-reference/10 UI Components/dxDataGrid/1 Configuration/summary/totalItems/column.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,26 @@ id: dxDataGrid.Options.summary.totalItems.column
33
---
44
---
55
##### shortDescription
6-
Specifies the column that provides data for a summary item.
6+
Specifies the summary item's data column.
77

88
---
9-
To provide data for a summary item, assign the [name](/api-reference/_hidden/GridBaseColumn/name.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#name'), [data field](/api-reference/_hidden/GridBaseColumn/dataField.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#dataField') or [caption](/api-reference/_hidden/GridBaseColumn/caption.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#caption') of a column to this property. The summary item will be displayed in the corresponding column. If you require to place the summary item in another column, set the [showInColumn](/api-reference/10%20UI%20Components/dxDataGrid/1%20Configuration/summary/totalItems/showInColumn.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/summary/totalItems/#showInColumn') property for this item.
9+
To specify the data column of a summary item, assign a column [name](/api-reference/_hidden/GridBaseColumn/name.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#name'), [data field](/api-reference/_hidden/GridBaseColumn/dataField.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#dataField') or [caption](/api-reference/_hidden/GridBaseColumn/caption.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#caption') to this property. DataGrid uses this column's values to calculate the summary item.
10+
11+
The component displays summary items in their corresponding data columns. To display a summary item in another column, configure the [showInColumn](/api-reference/10%20UI%20Components/dxDataGrid/1%20Configuration/summary/totalItems/showInColumn.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/summary/totalItems/#showInColumn') property.
12+
13+
[note]
14+
15+
If you do not specify **column**, note the following specifics:
16+
17+
- The component does not display the summary item if you do not specify **showInColumn**.
18+
- DataGrid uses row data objects to calculate summaries, which affects calculated values. For instance, the *"max"* [summary type](/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/summary/totalItems/#summaryType) returns "[object Object]".
19+
20+
[/note]
1021

1122
#include btn-open-demo with {
1223
href: "https://js.devexpress.com/Demos/WidgetsGallery/Demo/DataGrid/GridSummaries/"
1324
}
1425

1526
#####See Also#####
1627
- [Total Summary](/concepts/05%20UI%20Components/DataGrid/65%20Summaries/10%20Total%20Summary '/Documentation/Guide/UI_Components/DataGrid/Summaries/Total_Summary/')
17-
- [calculateCustomSummary](/api-reference/10%20UI%20Components/dxDataGrid/1%20Configuration/summary/calculateCustomSummary.md 'Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/summary/#calculateCustomSummary')
28+
- [calculateCustomSummary](/api-reference/10%20UI%20Components/dxDataGrid/1%20Configuration/summary/calculateCustomSummary.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/summary/#calculateCustomSummary')

0 commit comments

Comments
 (0)