Skip to content

Commit 6befb5f

Browse files
committed
[update] sidebar labels and titles for TreeGrid mode api
1 parent 3398546 commit 6befb5f

File tree

2 files changed

+11
-13
lines changed

2 files changed

+11
-13
lines changed

docs/grid/configuration.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1281,6 +1281,10 @@ const grid = new dhx.Grid("grid_container", {
12811281
},
12821282
data: dataset
12831283
});
1284+
1285+
// an example of getting the values of population density
1286+
const summary = grid.getSummary();
1287+
console.log(summary); // { totalPopulation: 1000000, totalArea: 50000, density: 20.00 }
12841288
~~~
12851289

12861290
In the above example the [`dhx.methods`](helpers/data_calculation_functions.md) helper is used to:
@@ -1290,13 +1294,7 @@ In the above example the [`dhx.methods`](helpers/data_calculation_functions.md)
12901294

12911295
### Getting the summary object
12921296

1293-
To get the object with the calculated values, you should use the [`getSummary()`](grid/api/grid_getsummary_method.md) method. When called without parameters, the method returns an object with the calculated values defined in the configuration of the component:
1294-
1295-
~~~jsx
1296-
// an example of getting the values of population density
1297-
const summary = grid.getSummary();
1298-
console.log(summary); // { totalPopulation: 1000000, totalArea: 50000, density: 20.00 }
1299-
~~~
1297+
To get the object with the calculated values, you should use the [`getSummary()`](grid/api/grid_getsummary_method.md) method. When called without parameters, the method returns an object with the calculated values defined in the configuration of the component.
13001298

13011299
You can also pass the `id` of a column to the method to get an object with the calculated values defined in the column's configuration together with the calculated values defined in the component's configuration. In the following example calculated values are used for rendering the summary for a column:
13021300

sidebars.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2732,10 +2732,10 @@ module.exports = {
27322732
items: [
27332733
{
27342734
type: "category",
2735-
label: "Grid TreeGrid mode methods",
2735+
label: "Methods",
27362736
link: {
27372737
type: 'generated-index',
2738-
title: "Grid TreeGrid mode methods",
2738+
title: "Methods",
27392739
keywords: ['grid treegrid mode methods'],
27402740
image: '/img/docusaurus.png'
27412741
},
@@ -2748,10 +2748,10 @@ module.exports = {
27482748
},
27492749
{
27502750
type: "category",
2751-
label: "Grid TreeGrid mode events",
2751+
label: "Events",
27522752
link: {
27532753
type: 'generated-index',
2754-
title: "Grid TreeGrid mode events",
2754+
title: "Events",
27552755
keywords: ['grid treegrid mode events'],
27562756
image: '/img/docusaurus.png'
27572757
},
@@ -2765,10 +2765,10 @@ module.exports = {
27652765
},
27662766
{
27672767
type: "category",
2768-
label: "Grid TreeGrid mode properties",
2768+
label: "Properties",
27692769
link: {
27702770
type: 'generated-index',
2771-
title: "Grid TreeGrid mode properties",
2771+
title: "Properties",
27722772
keywords: ['grid treegrid mode properties'],
27732773
image: '/img/docusaurus.png'
27742774
},

0 commit comments

Comments
 (0)