Skip to content

Commit 16f5533

Browse files
committed
[update] complete docs for v9.3
1 parent 4fbd518 commit 16f5533

16 files changed

Lines changed: 59 additions & 46 deletions
-1.77 KB
Loading
-2.05 KB
Loading

docs/grid/api/grid_dropbehaviour_config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,6 @@ There are three modes of behaviour of a dragged item, depending on the value set
4141
- "sibling" - a dragged item becomes a sibling of the item it is dragged to
4242
- "complex" - a dragged item can become both a child or a sibling of a target item, depending on the position specified by highlighting
4343

44-
**Related sample**: [Grid (TreeGrid). Drop behaviour](https://snippet.dhtmlx.com/l5waxyqe)
44+
**Related sample**: [Grid (TreeGrid). Drop behaviour](https://snippet.dhtmlx.com/o2v3pcg0)
4545

4646
**Related article**: [Drop behaviour](/grid/treegrid_mode/#drop-behaviour)

docs/grid/api/grid_exportconfig_config.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,10 @@ exportConfig?: (config: IGridConfig, exportType: "pdf" | "png" | "csv" | "xlsx")
3333

3434
The `exportConfig` property is a callback function that takes the following parameters:
3535

36-
- `config` - (*IGridConfig*) the current configuration of a Grid instance
37-
- `exportType` - (*string*) the type of export being performed: "pdf", "png", "csv", or "xlsx"
36+
| Parameter | Description |
37+
|------------------ |---------------------------------------------------------------------------------- |
38+
| `config` | (*IGridConfig*) the current configuration of a Grid instance |
39+
| `exportType` | (*string*) the type of export being performed: "pdf", "png", "csv", or "xlsx" |
3840

3941
and returns a configuration object with export parameters. The returned configuration object may contain the following properties:
4042

@@ -160,7 +162,7 @@ The `exportConfig` property extends the possibilities of the standard export and
160162
- **define format-specific settings**: set delimiters for CSV, date masks for Excel, or visual themes for PDF
161163
- **adjust styling**: override Grid properties (such as row height) specifically for the exported file
162164

163-
**Related sample**: [Grid. Custom export logic for PDF, PNG, XLSX, CSV](https://snippet.dhtmlx.com/k4wberkh)
165+
**Related sample**: [Grid. Custom export logic for PDF, PNG, XLSX, CSV](https://snippet.dhtmlx.com/aher21cg)
164166

165167
**Related article**: [Extended export configuration settings](/grid/usage/#extended-export-configuration-settings)
166168

docs/grid/api/grid_footerposition_config.md

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

77
# footerPosition
88

9-
@short: Optional. Defines the positioning logic for the `footer` and bottom-pinned rows (`bottomSplit`) within the component container
9+
:::tip pro version only
10+
This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package.
11+
:::
12+
13+
@short: Optional. Defines the positioning logic for the footer and bottom-pinned rows within the component container
1014

1115
@signature: {'footerPosition?: "bottom" | "relative";'}
1216

@@ -26,12 +30,12 @@ const grid = new dhx.Grid("grid_container", {
2630
The property has the following values:
2731

2832
- `relative` - the footer follows the content immediately. If the number of rows is small and doesn't fill the container, the footer moves up to stay attached to the last row.
29-
- `bottom` - the footer and bottom-pinned rows are strictly locked to the bottom edge of the container. They remain at the base of the component even if the content occupies only a fraction of the available height.
33+
- `bottom` - the footer and [bottom-pinned rows](/grid/api/grid_bottomsplit_config/) are strictly locked to the bottom edge of the container. They remain at the base of the component even if the content occupies only a fraction of the available height.
3034

3135
@changelog: added in v9.3
3236

3337
**Related sample**:
34-
- [Grid. Fixed rows positioned at the bottom](https://snippet.dhtmlx.com/8n0pdqhp)
35-
- [Grid. Footer positioned at the bottom](https://snippet.dhtmlx.com/etg7raih)
38+
- [Grid. Fixed rows positioned at the bottom](https://snippet.dhtmlx.com/w5xzdjb7)
39+
- [Grid. Footer positioned at the bottom](https://snippet.dhtmlx.com/8sbf8b2y)
3640

3741
**Related article**: [Configuration](/grid/configuration/#footer-position)

docs/grid/configuration.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1373,7 +1373,7 @@ const grid = new dhx.Grid("grid_container", {
13731373

13741374
### Header/footer filters
13751375

1376-
There are the following types of filters that you can specify in the header/footer content of a [Grid column](grid/api/grid_columns_config.md): **inputFilter**, **selectFilter**, **comboFilter**, **dateFilter** (**PRO version**).
1376+
There are the following types of filters that you can specify in the header/footer content of a [Grid column](grid/api/grid_columns_config.md): `inputFilter`, `selectFilter`, `comboFilter`, `dateFilter` (**PRO version**).
13771377

13781378
- **inputFilter**
13791379

@@ -1403,7 +1403,7 @@ If you specify **inputFilter** as the header or footer content of a column, you
14031403
}
14041404
~~~
14051405

1406-
**Related sample**: [Grid. Header filters (comboFilter, inputFilter, selectFilter, dateFilter)](https://snippet.dhtmlx.com/4qz8ng3c)
1406+
**Related sample**: [Grid. Header filters (dateFilter, comboFilter, inputFilter, selectFilter)](https://snippet.dhtmlx.com/4qz8ng3c)
14071407

14081408
- **selectFilter**
14091409

@@ -1418,7 +1418,7 @@ Allows end users to filter data of a column by choosing an option from a present
14181418
}
14191419
~~~
14201420

1421-
**Related sample**: [Grid. Header filters (comboFilter, inputFilter, selectFilter, dateFilter)](https://snippet.dhtmlx.com/4qz8ng3c)
1421+
**Related sample**: [Grid. Header filters (dateFilter, comboFilter, inputFilter, selectFilter](https://snippet.dhtmlx.com/4qz8ng3c)
14221422

14231423
- **comboFilter**
14241424

@@ -1456,7 +1456,7 @@ If you specify **comboFilter** as the header or footer content of a column, you
14561456
}
14571457
~~~
14581458

1459-
**Related sample**: [Grid. Header filters (comboFilter, inputFilter, selectFilter, dateFilter)](https://snippet.dhtmlx.com/4qz8ng3c)
1459+
**Related sample**: [Grid. Header filters (dateFilter, comboFilter, inputFilter, selectFilter](https://snippet.dhtmlx.com/4qz8ng3c)
14601460

14611461
- **dateFilter**
14621462

@@ -1515,7 +1515,7 @@ Calendar API configuration properties:
15151515
}
15161516
~~~
15171517

1518-
**Related sample**: [Grid. Header filters (comboFilter, inputFilter, selectFilter, dateFilter)](https://snippet.dhtmlx.com/4qz8ng3c)
1518+
**Related sample**: [Grid. Header filters (dateFilter, comboFilter, inputFilter, selectFilter)](https://snippet.dhtmlx.com/4qz8ng3c)
15191519

15201520
### Customizing header/footer filters
15211521

@@ -1548,7 +1548,7 @@ const grid = new dhx.Grid("grid_container", {
15481548
});
15491549
~~~
15501550

1551-
**Related sample**: [Grid. Custom filters in the header](https://snippet.dhtmlx.com/gcidkxjg)
1551+
**Related sample**: [Grid. Custom filters in the header (dateFilter, comboFilter, inputFilter, selectFilter)](https://snippet.dhtmlx.com/gcidkxjg)
15521552

15531553
### Header/footer height
15541554

@@ -1602,13 +1602,17 @@ const grid2 = new dhx.Grid("grid", {
16021602

16031603
### Footer position
16041604

1605-
You can define the logic of setting the position of the Grid footer as well as of the frozen rows set in the Grid configuration by the `bottomSplit` option with another Grid property `footerPosition`. The property has the following values:
1605+
:::tip pro version only
1606+
This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package.
1607+
:::
1608+
1609+
You can define the logic of setting the position of the Grid footer as well as of the frozen rows fixed at the Grid bottom by the [`bottomSplit`](/grid/api/grid_bottomsplit_config/) option with another Grid property [`footerPosition`](/grid/api/grid_footerposition_config/). The property has the following values:
16061610

16071611
- `relative` - (default) the footer follows the content immediately. If the number of rows is small and doesn't fill the container, the footer moves up to stay attached with the last row.
16081612
16091613
![](../assets/grid/footer_relative_position.png)
16101614
1611-
- `bottom` - the footer and bottom-pinned rows are strictly locked to the bottom edge of the container. They remain at the base of the component even if the content occupies only a fraction of the available height.
1615+
- `bottom` - the footer and bottom-pinned (frozen) rows are strictly locked to the bottom edge of the container. They remain at the base of the component even if the content takes only a part of the available height.
16121616
16131617
![](../assets/grid/footer_bottom_position.png)
16141618
@@ -1626,8 +1630,8 @@ const grid = new dhx.Grid("grid_container", {
16261630
~~~
16271631
16281632
**Related samples**:
1629-
- [Grid. Fixed rows positioned at the bottom](https://snippet.dhtmlx.com/8n0pdqhp)
1630-
- [Grid. Footer positioned at the bottom](https://snippet.dhtmlx.com/etg7raih)
1633+
- [Grid. Fixed rows positioned at the bottom](https://snippet.dhtmlx.com/w5xzdjb7)
1634+
- [Grid. Footer positioned at the bottom](https://snippet.dhtmlx.com/8sbf8b2y)
16311635
16321636
## Rows
16331637

docs/grid/features.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ In this section you can learn how to configure the header and footer of Grid, ho
102102
| [Configuring header/footer](../api/api_gridcolumn_properties/) | Learn how to configure a Grid header/footer ([Example](https://snippet.dhtmlx.com/9jl55ep7)) |
103103
| [Setting the height for header and footer](../configuration/#headerfooter-height) | Learn how to set the height for rows in the header and footer of Grid ([Example](https://snippet.dhtmlx.com/wjcjl80i)) |
104104
| [Setting the text for header and footer](../configuration/#headerfooter-text) | Learn how to set the text for rows in the header and footer of Grid ([Example](https://snippet.dhtmlx.com/9jl55ep7)) |
105-
| [Setting the position of the footer](../configuration/#footer-position) | Learn how to set the position of the footer and bottom-pinned rows ([Example 1](https://snippet.dhtmlx.com/etg7raih), [Example 2](https://snippet.dhtmlx.com/8n0pdqhp)) |
105+
| [Setting the position of the footer](../configuration/#footer-position) | Learn how to set the position of the footer and bottom-pinned rows ([Example 1](https://snippet.dhtmlx.com/w5xzdjb7), [Example 2](https://snippet.dhtmlx.com/8sbf8b2y)) |
106106
| [Styling header cells](../customization/#styling-header-cells) | Learn how to set styling to the text of header cells ([Example](https://snippet.dhtmlx.com/7o4elf48)) |
107107
| [Styling footer cells](../customization/#styling-footer-cells) | Learn how to set styling to the text of footer cells ([Example](https://snippet.dhtmlx.com/d254hcvp)) |
108108

@@ -356,7 +356,7 @@ In this section you will get to know how to export Grid to different formats.
356356
| Topic | Description |
357357
| --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
358358
| [Exporting Grid to XLSX, CSV, PNG or PDF format](../usage/#exporting-data) | Learn how to export Grid to the necessary format ([Example 1](https://snippet.dhtmlx.com/58oqij47), [Example 2](https://snippet.dhtmlx.com/ti9l91mn)) |
359-
| [Extended export configuration settings](../usage/#extended-export-configuration-settings)| Learn how to provide extended configuration properties for Grid export ([Example](https://snippet.dhtmlx.com/k4wberkh))|
359+
| [Extended export configuration settings](../usage/#extended-export-configuration-settings)| Learn how to provide extended configuration properties for Grid export ([Example](https://snippet.dhtmlx.com/aher21cg))|
360360

361361
## How to localize Grid
362362

docs/grid/treegrid_mode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ const grid = new dhx.Grid("treegrid_container", {
230230
});
231231
~~~
232232

233-
**Related sample**: [Grid (TreeGrid). Drop behaviour](https://snippet.dhtmlx.com/l5waxyqe)
233+
**Related sample**: [Grid (TreeGrid). Drop behaviour](https://snippet.dhtmlx.com/o2v3pcg0)
234234

235235
### Expanding collapsed rows on drag-n-drop
236236

docs/grid/usage.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -585,8 +585,10 @@ Unlike the standard export, [`exportConfig`](/grid/api/grid_exportconfig_config/
585585

586586
The `exportConfig` property is a callback function that takes the following parameters:
587587

588-
- `config` - (*IGridConfig*) the current configuration of a Grid instance
589-
- `exportType` - (*string*) the type of export being performed: "pdf", "png", "csv", or "xlsx"
588+
| Parameter | Description |
589+
|------------------ |---------------------------------------------------------------------------------- |
590+
| `config` | (*IGridConfig*) the current configuration of a Grid instance |
591+
| `exportType` | (*string*) the type of export being performed: "pdf", "png", "csv", or "xlsx" |
590592

591593
The returned configuration object may contain the following properties:
592594

@@ -701,7 +703,7 @@ const grid = new dhx.Grid("grid_container", {
701703
});
702704
~~~
703705

704-
**Related sample**: [Grid. Custom export logic for PDF, PNG, XLSX, CSV](https://snippet.dhtmlx.com/k4wberkh)
706+
**Related sample**: [Grid. Custom export logic for PDF, PNG, XLSX, CSV](https://snippet.dhtmlx.com/aher21cg)
705707

706708
## Grouping data
707709

docs/tree/api/tree_tooltip_config.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,11 @@ tooltip?:
2626
}
2727
~~~
2828

29-
@values:
30-
- `boolean` — if `true`, enables the standard tooltip (the value is taken from the [`value`](/tree/api/tree_data_config/) property of the item)
31-
- `function` — a template function that returns the string content of the tooltip
32-
- `object` — a configuration object for detailed customization of the tooltip's behavior and appearance. Check the available properties below
29+
The property can have three types of values:
30+
31+
- *boolean* — if `true`, enables the standard tooltip (the value is taken from the [`value`](/tree/api/tree_data_config/) property of the item)
32+
- *function* — a template function that returns the string content of the tooltip
33+
- *object* — a configuration object for detailed customization of the tooltip's behavior and appearance. Check the available properties below
3334

3435
@params:
3536

@@ -81,7 +82,7 @@ const tree = new dhx.Tree("tree_container", {
8182
});
8283
~~~
8384
84-
**Related sample**: [Tree. Adding tooltips for the items](https://snippet.dhtmlx.com/7j097ht4)
85+
**Related sample**: [Tree. Tooltip template](https://snippet.dhtmlx.com/kswil8cl)
8586
8687
**Related article**: [Configuration](/tree/configuration/#tooltips-for-items)
8788

0 commit comments

Comments
 (0)