Skip to content

Commit a609089

Browse files
committed
[update] grid guides
1 parent b5de6f0 commit a609089

File tree

3 files changed

+14
-12
lines changed

3 files changed

+14
-12
lines changed

docs/grid/configuration.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1183,22 +1183,22 @@ But if you need the editor to open after a single click, apply the [](grid/api/g
11831183
Note, that it does not work for the select editor (`editorType: "select"`) and you need to use the combobox editor (`editorType:"combobox"`) if you want a drop-down list to open on the mouse click.
11841184
:::
11851185
1186-
## Summary of calculated values
1186+
## Custom statistics in the column header/footer and spans
11871187
1188-
You can get the summary of calculated values based on the columns data using the Grid API. First, you need to form a summary list on the needed level: for a [particular column](#column-summary) or for the [whole component](#grid-summary). After that, you can [get the object with the calculated values](#getting-the-summary-object) using the `getSummary()` method.
1188+
You can form the summary of calculated values based on the columns data for a [particular column](#column-summary) or for the [whole component](#grid-summary) and render custom statistics by using the column and Grid summary in:
1189+
- the configuration objects of the [`text`](#headerfooter-text) and [`tooltipTemplate`](#column-headerfooter-tooltip) properties of the column header/footer
1190+
- the configuration objects of the `text` and `tooltipTemplate` properties of the Grid [`spans`](#spans) property
11891191
1190-
:::info
1191-
Use the [`dhx.methods`](helpers/data_calculation_functions.md) helper to define the default statistical functions and to create custom functions for data calculation while creating the summary list.
1192-
:::
1193-
1194-
The calculated values from the `summary` property of a column or Grid can be used:
1195-
- in the configuration objects of the [`text`](#headerfooter-text) and [`tooltipTemplate`](#column-headerfooter-tooltip) properties of the column header/footer
1196-
- in the configuration objects of the `text` and `tooltipTemplate` properties of the Grid [`spans`](#spans) property
1192+
It is also possible to [get the object with the calculated values](#getting-the-summary-object) using the `getSummary()` method.
11971193
11981194
**Related sample:** [Grid. Custom totals for footer and columns](https://snippet.dhtmlx.com/jhjxjv2l)
11991195
12001196
**Related sample:** [Grid. Custom totals for footer and columns with dynamic updates on edit](https://snippet.dhtmlx.com/59d6hqtm)
12011197
1198+
:::info
1199+
Use the [`dhx.methods`](helpers/data_calculation_functions.md) helper to define the default statistical functions and to create custom functions for data calculation while creating the summary list.
1200+
:::
1201+
12021202
### Column summary
12031203
12041204
To form a summary list that will be available at the column's level only, you should use the [`summary`](grid/api/api_gridcolumn_properties.md) configuration option of the column. The `summary` configuration option of a column can be initialized either as an *object* or as a *string*. As an object it contains calculated values set as *key:value* pairs, where the *keys* are the field names and *values* can be:

docs/grid/usage.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -477,7 +477,9 @@ grid.export.png({
477477
The described functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package.
478478
:::
479479

480-
You can group row data by column values to make them more suitable for analysis. It is possible to set a predefined Grid configuration to initialize Grid with grouped data or to use the [DataCollection API](../../data_collection) for grouping Grid data. Besides, you can group Grid rows via the UI.
480+
You can group row data by column values to make them more suitable for analysis. The Grid row data grouping functionality allows aggregating data in a group, adjusting the appearance, order and configuration of data grouping and rendering statistics in the summary rows.
481+
482+
It is possible to [set a predefined Grid configuration](#configuring-data-grouping) to initialize Grid with grouped data or to use the [DataCollection API](#using-datacollection-api-for-data-grouping) for grouping Grid data.
481483

482484
**Related sample:** [Grid. Grouping (PRO)](https://snippet.dhtmlx.com/dvqy4ewe)
483485

docs/whatsnew.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ In this version TreeGrid becomes a part of Grid. Check the [Migration](migration
4343
- new Grid properties: [`group`](grid/api/grid_group_config.md), [`groupable`](grid/api/grid_groupable_config.md), [`closable`](grid/api/grid_closable_config.md)
4444
- new column properties: [`groupable`](grid/api/api_gridcolumn_properties.md), [`closable`](grid/api/api_gridcolumn_properties.md)
4545
- new events: [`groupPanelItemClick`](grid/api/grid_grouppanelitemclick_event.md), [`groupPanelItemMouseDown`](grid/api/grid_grouppanelitemmousedown_event.md)
46-
- The ability to [render custom statistics in the header/footer of columns and Grid spans](grid/configuration.md#summary-of-calculated-values)
47-
- the `text` and `tooltipTemplate` properties of a column and of the Grid `spans` configuration object can be set as callback functions [to render calculated summary values](grid/configuration.md#summary-of-calculated-values)
46+
- The ability to [render custom statistics in the header/footer of columns and Grid spans](grid/configuration.md#custom-statistics-in-the-column-headerfooter-and-spans)
47+
- the `text` and `tooltipTemplate` properties of a column and of the Grid `spans` configuration object can be set as callback functions [to render calculated summary values](grid/configuration.md#custom-statistics-in-the-column-headerfooter-and-spans)
4848
- new Grid property: [`summary`](grid/api/grid_summary_config.md)
4949
- new method: [`getSummary()`](grid/api/grid_getsummary_method.md)
5050
- new column property: [`summary`](grid/api/api_gridcolumn_properties.md)

0 commit comments

Comments
 (0)