Skip to content

Commit 2e51167

Browse files
committed
[update] minor corrections in the grid column properties descriptions
1 parent 5d6b505 commit 2e51167

File tree

5 files changed

+6
-6
lines changed

5 files changed

+6
-6
lines changed

docs/grid/api/gridcolumn_properties/gridcolumn_footer_property.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ Each footer object may include:
3838
<table>
3939
<tbody>
4040
<tr>
41-
<td><a href="../../../configuration/#headerfooter-text"><b>text</b></a></td><td>(optional) the text of a header or a callback function which is called with the following parameter:<ul><li><b>content</b> - an object with the content of the footer tooltip that contains the calculated values as *key:value* pairs, where:<ul><li>the *key* is either the key defined in the list or the functor name</li><li>the *value* can be a *string/number* or *null*</li></ul> The calculated values are taken either from the <b>summary</b> config option of the component or the <b>summary</b> config option of a column</li></ul></td>
41+
<td><a href="../../../configuration/#headerfooter-text"><b>text</b></a></td><td>(optional) the text of a footer or a callback function which is called with the following parameter:<ul><li><b>content</b> - an object with the content of the footer tooltip that contains the calculated values as *key:value* pairs, where:<ul><li>the *key* is either the key defined in the list or the functor name</li><li>the *value* can be a *string/number* or *null*</li></ul> The calculated values are taken either from the <b>summary</b> config option of the component or the <b>summary</b> config option of a column</li></ul></td>
4242
</tr>
4343
<tr>
44-
<td><b>tooltip</b></td><td>(optional) enables/disables the header tooltip, or sets the configuration object with the tooltip settings; <i>true</i> by default. When set as an object, the <b>tooltip</b> config can have the following properties:<ul><li><b>force</b> - (optional) forces opening of a tooltip; if set to true, the <b>showDelay</b> and <b>hideDelay</b> settings are ignored, *false* by default</li><li><b>showDelay</b> - (optional) the time period that should pass before showing a tooltip, in ms</li><li><b>hideDelay</b> - (optional) the time period that should pass before hiding a tooltip, in ms</li><li><b>margin</b> - (optional) the margin between the node and tooltip; *8px* by default</li><li><b>position</b> - (optional) the position of a tooltip: *"right"*, *"bottom"*, *"center"*, *"left"*, *"top"*; *"bottom"* by default</li><li><b>css</b> - (optional) the style of a tooltip box</li></ul></td>
44+
<td><b>tooltip</b></td><td>(optional) enables/disables the footer tooltip, or sets the configuration object with the tooltip settings; <i>true</i> by default. When set as an object, the <b>tooltip</b> config can have the following properties:<ul><li><b>force</b> - (optional) forces opening of a tooltip; if set to true, the <b>showDelay</b> and <b>hideDelay</b> settings are ignored, *false* by default</li><li><b>showDelay</b> - (optional) the time period that should pass before showing a tooltip, in ms</li><li><b>hideDelay</b> - (optional) the time period that should pass before hiding a tooltip, in ms</li><li><b>margin</b> - (optional) the margin between the node and tooltip; *8px* by default</li><li><b>position</b> - (optional) the position of a tooltip: *"right"*, *"bottom"*, *"center"*, *"left"*, *"top"*; *"bottom"* by default</li><li><b>css</b> - (optional) the style of a tooltip box</li></ul></td>
4545
</tr>
4646
<tr>
4747
<td><a href="../../../configuration/#column-headerfooter-tooltip"><b>tooltipTemplate</b></a></td><td>(optional) sets a template for the footer tooltip. Takes into account the <a href="../../../configuration/#html-content-of-grid-columns">htmlEnable</a> property. The value of the <b>tooltipTemplate</b> property is a callback function which is called with the following parameters:<ul><li><b>content</b> - an object with the content of the footer tooltip. Contains two properties which are available either from the component's or from the column's configuration:<ul><li><b>value</b> - the value rendered in a cell, including the applied templates</li><li>an object with the calculated values of the <b>summary</b> property, set as *key:value* pairs where:<ul><li>the *key* is either the key defined in the list or the functor name</li><li>the *value* can be a *string/number* or *null*</li></ul></li></ul></li><li><b>footer</b> - the object of the column footer</li><li><b>column</b> - the object of a column</li></ul>Return <i>false</i> to disable the tooltip</td>

docs/grid/api/gridcolumn_properties/gridcolumn_template_property.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The `template` function takes 3 parameters:
2020

2121
- **cellValue** - (required) the value of a cell
2222
- **row** - (required) an object with all cells in a row
23-
- **column** - (required) an object with the configuration of a column (see the [columns](grid/api/grid_columns_config.md) config)
23+
- **column** - (required) an object with the configuration of a column (see the [`columns`](grid/api/grid_columns_config.md) config)
2424

2525
@descr:
2626
### Example

docs/grid/api/gridcolumn_properties/gridcolumn_tooltip_property.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ tooltip?: boolean | object;
2020

2121
When set as an object, the `tooltip` config can have the following properties:
2222

23-
- **force** - (optional) forces opening of a tooltip; if set to true, the showDelay and hideDelay settings are ignored, *false* by default
23+
- **force** - (optional) forces opening of a tooltip; if set to true, the `showDelay` and `hideDelay` settings are ignored, *false* by default
2424
- **showDelay** - (optional) the time period that should pass before showing a tooltip, in ms
2525
- **hideDelay** - (optional) the time period that should pass before hiding a tooltip, in ms
2626
- **margin** - (optional) the margin between the node and tooltip; *8px* by default

docs/grid/api/gridcolumn_properties/gridcolumn_tooltiptemplate_property.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The `tooltipTemplate` function takes 3 parameters:
2020

2121
- **value** - (required) the value of a cell
2222
- **row** - (required) an object with all cells in a row
23-
- **column** - (required) an object with the configuration of a column (see the [columns](grid/api/grid_columns_config.md) config)
23+
- **column** - (required) an object with the configuration of a column (see the [`columns`](grid/api/grid_columns_config.md) config)
2424

2525
Returning *false* from the function will block showing of the tooltip.
2626

docs/grid/api/gridcolumn_properties/gridcolumn_width_property.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The property is ignored if the [`adjust`](grid/api/gridcolumn_properties/gridcol
1616
### Usage
1717

1818
~~~jsx
19-
width?: number,
19+
width?: number;
2020
~~~
2121

2222
@default: 100

0 commit comments

Comments
 (0)