Skip to content

Commit 83a56f8

Browse files
mafanya23mafanya23
authored
Merge pull request #55 from DHTMLX/next
Update grid column properties' api pages
2 parents f6f2bff + 6f02d7f commit 83a56f8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+1521
-276
lines changed

‎docs/grid/api/api_gridcolumn_properties.md‎

Lines changed: 37 additions & 246 deletions
Large diffs are not rendered by default.

‎docs/grid/api/grid_adjust_config.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,17 +48,17 @@ The property can be specified to one of the available adjustment modes:
4848
</tbody>
4949
</table>
5050

51-
The **adjust** property has a priority over the [autoWidth](../../../grid/configuration/#autowidth-for-columns) property if it is specified either for a grid or for its column, and over the [width](../../../grid/api/api_gridcolumn_properties/) property of the column.
51+
The `adjust` property has a priority over the [`autoWidth`](../../../grid/configuration/#autowidth-for-columns) property if it is specified either for a grid or for its column, and over the [`width`](../../../grid/api/api_gridcolumn_properties/) property of the column.
5252

53-
The width the columns will be adjusted to also depends on the values of the [minWidth/maxWidth](../../../grid/api/api_gridcolumn_properties/) properties if they are set for a column.
53+
The width the columns will be adjusted to also depends on the values of the [`minWidth/maxWidth`](../../../grid/api/api_gridcolumn_properties/) properties if they are set for a column.
5454

5555
**Note** that:
5656

5757
- to optimize performance, you should specify `htmlEnable: true` in the configuration object of the column which contains HTML content
5858
- you can also specify `htmlEnable:true` in the configuration object of Grid
5959
- `htmlEnable: true` allows calculating the content of simple HTML templates by excluding HTML markup and calculating internal content
60-
- in case of complex HTML data, usage of the **adjust** config may lead to incorrect size calculations
61-
- the enabled **adjust** config (including the "header", "footer", "data" modes) adjusts the width of columns taking into account the [template](grid/api/api_gridcolumn_properties.md) added to cells. You need to set the **content** attribute of the [header/footer](grid/api/api_gridcolumn_properties.md) properties to one of the following modes: "avg" | "sum" | "max" | "min" | "count", otherwise **text** will be calculated
60+
- in case of complex HTML data, usage of the `adjust` config may lead to incorrect size calculations
61+
- the enabled `adjust` config (including the "header", "footer", "data" modes) adjusts the width of columns taking into account the [`template`](grid/api/api_gridcolumn_properties.md) added to cells. You need to set the **content** attribute of the [`header/footer`](grid/api/api_gridcolumn_properties.md) properties to one of the following modes: "avg" | "sum" | "max" | "min" | "count", otherwise **text** will be calculated
6262

6363
@changelog: added in v6.4
6464

‎docs/grid/api/grid_adjustcolumnwidth_method.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,6 @@ grid.adjustColumnWidth("b", "header");
1919

2020
@descr:
2121

22-
If no value is set to the *adjust* parameter, the **adjustColumnWidth** method sets it to *true*.
22+
If no value is set to the `adjust` parameter, the `adjustColumnWidth()` method sets it to *true*.
2323

2424
[comment]: # (@relatedapi: grid/api/grid_adjust_config.md)

‎docs/grid/api/grid_aftercolumndrag_event.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ description: You can explore the afterColumnDrag event of Grid in the documentat
66

77
# afterColumnDrag
88

9-
{{pronote This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package.}}
9+
:::tip pro version only
10+
The described functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package.
11+
:::
1012

1113
@short: fires after dragging of a column is finished
1214

‎docs/grid/api/grid_aftercolumndrop_event.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ description: You can explore the afterColumnDrop event of Grid in the documentat
66

77
# afterColumnDrop
88

9-
{{pronote This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package.}}
9+
:::tip pro version only
10+
The described functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package.
11+
:::
1012

1113
@short: fires before the user has finished dragging a column but after the mouse button is released
1214

‎docs/grid/api/grid_afterrowresize_event.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ description: You can explore the afterRowResize event of Grid in the documentati
66

77
# afterRowResize
88

9-
{{pronote This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package.}}
9+
:::tip pro version only
10+
The described functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package.
11+
:::
1012

1113
@short: fires after the height of a row is changed
1214

‎docs/grid/api/grid_autoheight_config.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ description: You can explore the autoHeight config of Grid in the documentation
66

77
# autoHeight
88

9-
{{pronote This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package.}}
9+
:::tip Pro version only
10+
This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package.
11+
:::
1012

1113
@short: Optional. Makes long text split into multiple lines based on the width of the column, controls the automatic height adjustment of the header/footer and cells with data
1214

@@ -29,8 +31,8 @@ const grid = new dhx.Grid("grid_container", {
2931

3032
You can control the autoheight of the header/footer separately with the help of the [](grid/api/grid_headerautoheight_config.md) and [](grid/api/grid_footerautoheight_config.md) configuration options of Grid. For example, you can disable autoheight of the header and the footer, while it is enabled for the whole Grid:
3133

32-
~~~js
33-
const grid = new dhx.Grid("grid", {
34+
~~~jsx
35+
const grid = new dhx.Grid("grid_container", {
3436
columns: [
3537
// columns config
3638
],
@@ -46,7 +48,7 @@ const grid = new dhx.Grid("grid", {
4648
- to optimize performance, you should specify `htmlEnable: true` in the configuration object of the column which contains HTML content
4749
- you can also specify `htmlEnable:true` in the configuration object of Grid
4850
- `htmlEnable: true` allows calculating the content of simple HTML templates by excluding HTML markup and calculating internal content
49-
- in case of complex HTML data, usage of the **autoHeight** config may lead to incorrect size calculations
51+
- in case of complex HTML data, usage of the `autoHeight` config may lead to incorrect size calculations
5052
- note that if you decide to change the font type, its size and offsets, correct calculation of the cell's autoHeight can't be ensured
5153

5254
@changelog: added in v7.1

‎docs/grid/api/grid_autowidth_config.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,15 @@ const grid = new dhx.Grid("grid_container", {
2525

2626
**Related sample**: [Grid. Columns auto width](https://snippet.dhtmlx.com/4as4y3l4)
2727

28-
{{note The property is ignored if the [adjust](../../../grid/configuration/#autosize-for-columns) property is used.}}
28+
:::note
29+
The property is ignored if the [`adjust`](../../../grid/configuration/#autosize-for-columns) property is used.
30+
:::
2931

30-
The width of the columns is calculated on the base of the sizes of the container of the grid and the values of the [minWidth/maxWidth](../../../grid/api/api_gridcolumn_properties/) properties if they are set for the columns.
32+
The width of the columns is calculated on the base of the sizes of the container of the grid and the values of the [`minWidth/maxWidth`](../../../grid/api/api_gridcolumn_properties/) properties if they are set for the columns.
3133

32-
{{note If the **width** property is specified in the configuration object of a column, the **autoWidth** property won't work for this column.}}
34+
:::note
35+
If the `width` property is specified in the configuration object of a column, the `autoWidth` property won't work for this column.
36+
:::
3337

3438

3539
@changelog: added in v6.4

‎docs/grid/api/grid_css_config.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ description: You can explore the css config of Grid in the documentation of the
4444

4545
Note, that the DHTMLX library provides [a set of own CSS classes](helpers/base_elements.md#list-of-css-classes-for-styling-a-widget) that you can also apply to change the appearance of Grid:
4646

47-
~~~js
47+
~~~jsx
4848
const grid = new dhx.Grid("grid_container", {
4949
css: "dhx_widget--bg_white"
5050
});

‎docs/grid/api/grid_dragitem_config.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ description: You can explore the dragItem config of Grid in the documentation of
66

77
# dragItem
88

9-
{{pronote This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package. <br>In case you use GPL version, you will be able to reorder rows only.}}
9+
:::tip pro version only
10+
This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package. <br>In case you use GPL version, you will be able to reorder rows only.
11+
:::
1012

1113
@short: Optional. Enables the possibility to reorder grid columns or (and) rows by drag and drop
1214

0 commit comments

Comments
 (0)