Skip to content

Commit efe799e

Browse files
mafanya23mafanya23
authored
Merge pull request #23 from DHTMLX/next
[add] docs updates for v5.2
2 parents 010cc05 + bd4337b commit efe799e

File tree

67 files changed

+1160
-261
lines changed

Some content is hidden

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

67 files changed

+1160
-261
lines changed

‎docs/api/api_overview.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,17 @@ Parameters:
3434
| [](api/spreadsheet_eachcell_method.md) | @getshort(api/spreadsheet_eachcell_method.md) |
3535
| [](api/spreadsheet_endedit_method.md) | @getshort(api/spreadsheet_endedit_method.md) |
3636
| [](api/spreadsheet_fitcolumn_method.md) | @getshort(api/spreadsheet_fitcolumn_method.md) |
37+
| [](api/spreadsheet_freezecols_method.md) | @getshort(api/spreadsheet_freezecols_method.md) |
38+
| [](api/spreadsheet_freezerows_method.md) | @getshort(api/spreadsheet_freezerows_method.md) |
3739
| [](api/spreadsheet_getactivesheet_method.md) | @getshort(api/spreadsheet_getactivesheet_method.md) |
3840
| [](api/spreadsheet_getfilter_method.md) | @getshort(api/spreadsheet_getfilter_method.md) |
3941
| [](api/spreadsheet_getformat_method.md) | @getshort(api/spreadsheet_getformat_method.md) |
4042
| [](api/spreadsheet_getformula_method.md) | @getshort(api/spreadsheet_getformula_method.md) |
4143
| [](api/spreadsheet_getsheets_method.md) | @getshort(api/spreadsheet_getsheets_method.md) |
4244
| [](api/spreadsheet_getstyle_method.md) | @getshort(api/spreadsheet_getstyle_method.md) |
4345
| [](api/spreadsheet_getvalue_method.md) | @getshort(api/spreadsheet_getvalue_method.md) |
46+
| [](api/spreadsheet_hidecols_method.md) | @getshort(api/spreadsheet_hidecols_method.md) |
47+
| [](api/spreadsheet_hiderows_method.md) | @getshort(api/spreadsheet_hiderows_method.md) |
4448
| [](api/spreadsheet_hidesearch_method.md) | @getshort(api/spreadsheet_hidesearch_method.md) |
4549
| [](api/spreadsheet_insertlink_method.md) | @getshort(api/spreadsheet_insertlink_method.md) |
4650
| [](api/spreadsheet_islocked_method.md) | @getshort(api/spreadsheet_islocked_method.md) |
@@ -58,8 +62,12 @@ Parameters:
5862
| [](api/spreadsheet_setstyle_method.md) | @getshort(api/spreadsheet_setstyle_method.md) |
5963
| [](api/spreadsheet_setvalidation_method.md) | @getshort(api/spreadsheet_setvalidation_method.md) |
6064
| [](api/spreadsheet_setvalue_method.md) | @getshort(api/spreadsheet_setvalue_method.md) |
65+
| [](api/spreadsheet_showcols_method.md) | @getshort(api/spreadsheet_showcols_method.md) |
66+
| [](api/spreadsheet_showrows_method.md) | @getshort(api/spreadsheet_showrows_method.md) |
6167
| [](api/spreadsheet_startedit_method.md) | @getshort(api/spreadsheet_startedit_method.md) |
6268
| [](api/spreadsheet_undo_method.md) | @getshort(api/spreadsheet_undo_method.md) |
69+
| [](api/spreadsheet_unfreezecols_method.md) | @getshort(api/spreadsheet_unfreezecols_method.md) |
70+
| [](api/spreadsheet_unfreezerows_method.md) | @getshort(api/spreadsheet_unfreezerows_method.md) |
6371
| [](api/spreadsheet_unlock_method.md) | @getshort(api/spreadsheet_unlock_method.md) |
6472

6573
## Spreadsheet events
@@ -70,6 +78,7 @@ Parameters:
7078
| [](api/spreadsheet_afterclear_event.md) | @getshort(api/spreadsheet_afterclear_event.md) |
7179
| [](api/spreadsheet_aftercolumnadd_event.md) | @getshort(api/spreadsheet_aftercolumnadd_event.md) |
7280
| [](api/spreadsheet_aftercolumndelete_event.md) | @getshort(api/spreadsheet_aftercolumndelete_event.md) |
81+
| [](api/spreadsheet_afterdataloaded_event.md) | @getshort(api/spreadsheet_afterdataloaded_event.md) |
7382
| [](api/spreadsheet_aftereditend_event.md) | @getshort(api/spreadsheet_aftereditend_event.md) |
7483
| [](api/spreadsheet_aftereditstart_event.md) | @getshort(api/spreadsheet_aftereditstart_event.md) |
7584
| [](api/spreadsheet_afterfocusset_event.md) | @getshort(api/spreadsheet_afterfocusset_event.md) |
@@ -113,15 +122,14 @@ Parameters:
113122
| [](api/spreadsheet_exportmodulepath_config.md) | @getshort(api/spreadsheet_exportmodulepath_config.md) |
114123
| [](api/spreadsheet_formats_config.md) | @getshort(api/spreadsheet_formats_config.md) |
115124
| [](api/spreadsheet_importmodulepath_config.md) | @getshort(api/spreadsheet_importmodulepath_config.md) |
116-
| [](api/spreadsheet_leftsplit_config.md) | @getshort(api/spreadsheet_leftsplit_config.md) |
117125
| [](api/spreadsheet_localization_config.md) | @getshort(api/spreadsheet_localization_config.md) |
118126
| [](api/spreadsheet_menu_config.md) | @getshort(api/spreadsheet_menu_config.md) |
119127
| [](api/spreadsheet_multisheets_config.md) | @getshort(api/spreadsheet_multisheets_config.md) |
120128
| [](api/spreadsheet_readonly_config.md) | @getshort(api/spreadsheet_readonly_config.md) |
121129
| [](api/spreadsheet_rowscount_config.md) | @getshort(api/spreadsheet_rowscount_config.md) |
122130
| [](api/spreadsheet_timeformat_config.md) | @getshort(api/spreadsheet_timeformat_config.md) |
123131
| [](api/spreadsheet_toolbarblocks_config.md) | @getshort(api/spreadsheet_toolbarblocks_config.md) |
124-
| [](api/spreadsheet_topsplit_config.md) | @getshort(api/spreadsheet_topsplit_config.md) |
132+
125133

126134
## Selection methods
127135

‎docs/api/overview/actions_overview.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,13 @@ spreadsheet.events.on("beforeColumnAdd", function(cell){
7474
| **setValidation** | The action is executed when setting data validation for a cell |
7575
| **sortCells** | The action is executed when sorting data in spreadsheet |
7676
| **setCellStyle** | The action is executed when changing the style of a cell |
77+
| **toggleVisibility** | The action is executed when hiding/showing columns/rows |
78+
| **toggleFreeze** | The action is executed when freezing/unfreezing columns/rows |
7779
| **unmerge** | The action is executed when splitting cells |
7880

7981
**Change log:**
8082

83+
- The **toggleFreeze** and **toggleVisibility** actions were added in v5.2
8184
- The **merge**, **unmerge**, **filter**, **fitColumn**, **insertLink** actions were added in v5.0
8285

8386
**Related sample:** [Spreadsheet. Actions](https://snippet.dhtmlx.com/efcuxlkt)

‎docs/api/overview/events_overview.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ description: You can have an Events overview of the DHTMLX JavaScript Spreadshee
1212
| [](../spreadsheet_afterclear_event.md) | @getshort(../spreadsheet_afterclear_event.md) |
1313
| [](../spreadsheet_aftercolumnadd_event.md) | @getshort(../spreadsheet_aftercolumnadd_event.md) |
1414
| [](../spreadsheet_aftercolumndelete_event.md) | @getshort(../spreadsheet_aftercolumndelete_event.md) |
15+
| [](../spreadsheet_afterdataloaded_event.md) | @getshort(../spreadsheet_afterdataloaded_event.md) |
1516
| [](../spreadsheet_aftereditend_event.md) | @getshort(../spreadsheet_aftereditend_event.md) |
1617
| [](../spreadsheet_aftereditstart_event.md) | @getshort(../spreadsheet_aftereditstart_event.md) |
1718
| [](../spreadsheet_afterfocusset_event.md) | @getshort(../spreadsheet_afterfocusset_event.md) |

‎docs/api/overview/methods_overview.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,16 @@ description: You can have a Methods overview of the DHTMLX JavaScript Spreadshee
1818
| [](../spreadsheet_eachcell_method.md) | @getshort(../spreadsheet_eachcell_method.md) |
1919
| [](../spreadsheet_endedit_method.md) | @getshort(../spreadsheet_endedit_method.md) |
2020
| [](../spreadsheet_fitcolumn_method.md) | @getshort(../spreadsheet_fitcolumn_method.md) |
21+
| [](../spreadsheet_freezecols_method.md) | @getshort(../spreadsheet_freezecols_method.md) |
22+
| [](../spreadsheet_freezerows_method.md) | @getshort(../spreadsheet_freezerows_method.md) |
2123
| [](../spreadsheet_getactivesheet_method.md) | @getshort(../spreadsheet_getactivesheet_method.md) |
2224
| [](../spreadsheet_getfilter_method.md) | @getshort(../spreadsheet_getfilter_method.md) |
2325
| [](../spreadsheet_getformat_method.md) | @getshort(../spreadsheet_getformat_method.md) |
2426
| [](../spreadsheet_getformula_method.md) | @getshort(../spreadsheet_getformula_method.md) |
2527
| [](../spreadsheet_getsheets_method.md) | @getshort(../spreadsheet_getsheets_method.md) |
2628
| [](../spreadsheet_getstyle_method.md) | @getshort(../spreadsheet_getstyle_method.md) |
29+
| [](../spreadsheet_hidecols_method.md) | @getshort(../spreadsheet_hidecols_method.md) |
30+
| [](../spreadsheet_hiderows_method.md) | @getshort(../spreadsheet_hiderows_method.md) |
2731
| [](../spreadsheet_hidesearch_method.md) | @getshort(../spreadsheet_hidesearch_method.md) |
2832
| [](../spreadsheet_getvalue_method.md) | @getshort(../spreadsheet_getvalue_method.md) |
2933
| [](../spreadsheet_insertlink_method.md) | @getshort(../spreadsheet_insertlink_method.md) |
@@ -42,6 +46,10 @@ description: You can have a Methods overview of the DHTMLX JavaScript Spreadshee
4246
| [](../spreadsheet_setstyle_method.md) | @getshort(../spreadsheet_setstyle_method.md) |
4347
| [](../spreadsheet_setvalidation_method.md) | @getshort(../spreadsheet_setvalidation_method.md) |
4448
| [](../spreadsheet_setvalue_method.md) | @getshort(../spreadsheet_setvalue_method.md) |
49+
| [](../spreadsheet_showcols_method.md) | @getshort(../spreadsheet_showcols_method.md) |
50+
| [](../spreadsheet_showrows_method.md) | @getshort(../spreadsheet_showrows_method.md) |
4551
| [](../spreadsheet_startedit_method.md) | @getshort(../spreadsheet_startedit_method.md) |
4652
| [](../spreadsheet_undo_method.md) | @getshort(../spreadsheet_undo_method.md) |
53+
| [](../spreadsheet_unfreezecols_method.md) | @getshort(../spreadsheet_unfreezecols_method.md) |
54+
| [](../spreadsheet_unfreezerows_method.md) | @getshort(../spreadsheet_unfreezerows_method.md) |
4755
| [](../spreadsheet_unlock_method.md) | @getshort(../spreadsheet_unlock_method.md) |

‎docs/api/overview/properties_overview.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,11 @@ description: You can have a Properties overview of the DHTMLX JavaScript Spreads
1414
| [](../spreadsheet_exportmodulepath_config.md) | @getshort(../spreadsheet_exportmodulepath_config.md) |
1515
| [](../spreadsheet_formats_config.md) | @getshort(../spreadsheet_formats_config.md) |
1616
| [](../spreadsheet_importmodulepath_config.md) | @getshort(../spreadsheet_importmodulepath_config.md) |
17-
| [](../spreadsheet_leftsplit_config.md) | @getshort(../spreadsheet_leftsplit_config.md) |
1817
| [](../spreadsheet_localization_config.md) | @getshort(../spreadsheet_localization_config.md) |
1918
| [](../spreadsheet_menu_config.md) | @getshort(../spreadsheet_menu_config.md) |
2019
| [](../spreadsheet_multisheets_config.md) | @getshort(../spreadsheet_multisheets_config.md) |
2120
| [](../spreadsheet_readonly_config.md) | @getshort(../spreadsheet_readonly_config.md) |
2221
| [](../spreadsheet_rowscount_config.md) | @getshort(../spreadsheet_rowscount_config.md) |
2322
| [](../spreadsheet_timeformat_config.md) | @getshort(../spreadsheet_timeformat_config.md) |
2423
| [](../spreadsheet_toolbarblocks_config.md) | @getshort(../spreadsheet_toolbarblocks_config.md) |
25-
| [](../spreadsheet_topsplit_config.md) | @getshort(../spreadsheet_topsplit_config.md) |
24+

‎docs/api/spreadsheet_afterdataloaded_event.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
sidebar_label: afterDataLoaded
3+
title: afterDataLoaded event
4+
description: You can learn about the afterDataLoaded event in the documentation of the DHTMLX JavaScript Spreadsheet library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Spreadsheet.
5+
---
6+
7+
# afterDataLoaded
8+
9+
### Description
10+
11+
@short: Fires after data loading is complete
12+
13+
### Usage
14+
15+
~~~jsx
16+
afterDataLoaded: () => void;
17+
~~~
18+
19+
### Example
20+
21+
~~~jsx
22+
const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", {});
23+
spreadsheet.parse(data);
24+
25+
// subscribe to the "afterDataLoaded" event
26+
spreadsheet.events.on("afterDataLoaded", () => {
27+
dhx.message({
28+
text: "Data is successfully loaded into Spreadsheet!",
29+
css: "dhx_message--success",
30+
expire: 5000
31+
});
32+
});
33+
~~~
34+
35+
**Change log:** Added in v5.2
36+
37+
**Related articles:** [Event handling](handling_events.md)
38+
39+
**Related sample:** [Spreadsheet. Data loaded event](https://snippet.dhtmlx.com/vxr7amz6)
40+

‎docs/api/spreadsheet_freezecols_method.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
sidebar_label: freezeCols()
3+
title: freezeCols method
4+
description: You can learn about the freezeCols method in the documentation of the DHTMLX JavaScript Spreadsheet library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Spreadsheet.
5+
---
6+
7+
# freezeCols()
8+
9+
### Description
10+
11+
@short: Fixes ("freezes") columns
12+
13+
### Usage
14+
15+
~~~jsx
16+
freezeCols(cell?: string): void;
17+
~~~
18+
19+
### Parameters
20+
21+
- `cell` - (optional) the id of the cell used to define the id of a column. If the cell id isn't passed, the currently selected cell will be used
22+
23+
### Example
24+
25+
~~~jsx
26+
spreadsheet.freezeCols("B2"); // the columns up to the "B" column will be fixed
27+
spreadsheet.freezeCols("sheet2!B2"); // the columns up to the "B" column in "sheet2" will be fixed
28+
~~~
29+
30+
**Related articles:** [Work with Spreadsheet](working_with_ssheet.md/#freezingunfreezing-rows-and-columns)
31+
32+
**Related API:** [`unfreezeCols()`](api/spreadsheet_unfreezecols_method.md/)
33+
34+
**Related sample:** [Spreadsheet. Freezing columns and rows via API](https://snippet.dhtmlx.com/a12xd1mn)
35+
36+
**Change log:**
37+
Added in v5.2

‎docs/api/spreadsheet_freezerows_method.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
sidebar_label: freezeRows()
3+
title: freezeRows method
4+
description: You can learn about the freezeRows method in the documentation of the DHTMLX JavaScript Spreadsheet library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Spreadsheet.
5+
---
6+
7+
# freezeRows()
8+
9+
### Description
10+
11+
@short: Fixes ("freezes") rows
12+
13+
### Usage
14+
15+
~~~jsx
16+
freezeRows(cell?: string): void;
17+
~~~
18+
19+
### Parameters
20+
21+
- `cell` - (optional) the id of the cell used to define the id of a row. If the cell id isn't passed, the currently selected cell will be used
22+
23+
### Example
24+
25+
~~~jsx
26+
spreadsheet.freezeRows("B2"); // the rows up to the "2" row will be fixed
27+
spreadsheet.freezeRows("sheet2!B2"); // the rows up to the "2" row in "sheet2" will be fixed
28+
~~~
29+
30+
**Related articles:** [Work with Spreadsheet](working_with_ssheet.md/#freezingunfreezing-rows-and-columns)
31+
32+
**Related API:** [`unfreezeRows()`](api/spreadsheet_unfreezerows_method.md/)
33+
34+
**Related sample:** [Spreadsheet. Freezing columns and rows via API](https://snippet.dhtmlx.com/a12xd1mn)
35+
36+
**Change log:**
37+
Added in v5.2

‎docs/api/spreadsheet_hidecols_method.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
sidebar_label: hideCols()
3+
title: hideCols method
4+
description: You can learn about the hideCols method in the documentation of the DHTMLX JavaScript Spreadsheet library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Spreadsheet.
5+
---
6+
7+
# hideCols()
8+
9+
### Description
10+
11+
@short: Hides columns
12+
13+
### Usage
14+
15+
~~~jsx
16+
hideCols(cell?: string): void;
17+
~~~
18+
19+
### Parameters
20+
21+
- `cell` - (optional) the id of the cell used to define the id of a column. If the cell id isn't passed, the currently selected cell will be used
22+
23+
### Example
24+
25+
~~~jsx
26+
spreadsheet.hideCols("B2"); // the "B" column will be hidden
27+
spreadsheet.hideCols("sheet2!B2"); // the "B" column in "sheet2" will be hidden
28+
spreadsheet.hideCols("B2:C2"); // the "B" and "C" columns will be hidden
29+
~~~
30+
31+
32+
**Related articles:** [Work with Spreadsheet](working_with_ssheet.md/#hidingshowing-rows-and-columns)
33+
34+
**Related API:** [`showCols()`](api/spreadsheet_showcols_method.md)
35+
36+
**Related sample:** [Spreadsheet. Hiding columns and rows via API](https://snippet.dhtmlx.com/zere1ote)
37+
38+
**Change log:** Added in v5.2

‎docs/api/spreadsheet_hiderows_method.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
sidebar_label: hideRows()
3+
title: hideRows method
4+
description: You can learn about the hideRows method in the documentation of the DHTMLX JavaScript Spreadsheet library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Spreadsheet.
5+
---
6+
7+
# hideRows()
8+
9+
### Description
10+
11+
@short: Hides rows
12+
13+
### Usage
14+
15+
~~~jsx
16+
hideRows(cell?: string): void;
17+
~~~
18+
19+
### Parameters
20+
21+
- `cell` - (optional) the id of the cell used to define the id of a row. If the cell id isn't passed, the currently selected cell will be used
22+
23+
### Example
24+
25+
~~~jsx
26+
spreadsheet.hideRows("B2"); // the "2" row will be hidden
27+
spreadsheet.hideRows("sheet2!B2"); // the "2" row in "sheet2" will be hidden
28+
spreadsheet.hideRows("B2:C4"); // the rows from "2" to "4" will be hidden
29+
~~~
30+
31+
**Related articles:** [Work with Spreadsheet](working_with_ssheet.md/#hidingshowing-rows-and-columns)
32+
33+
**Related API:** [`showRows()`](api/spreadsheet_showrows_method.md)
34+
35+
**Related sample:** [Spreadsheet. Hiding columns and rows via API](https://snippet.dhtmlx.com/zere1ote)
36+
37+
**Change log:** Added in v5.2

0 commit comments

Comments
 (0)