Skip to content

[add] docs updates for v5.2 #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 27 commits into from
May 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
ec7ac04
[update] localization guide
mafanya23 May 6, 2025
bb058d9
[update] complete docs on formulas popup
mafanya23 May 7, 2025
d7d8ae6
[add] a draft for what's new for v5.2
mafanya23 May 7, 2025
62d15c4
[update] toolbar-related docs and migration guide for v5.2
mafanya23 May 7, 2025
8b740c2
[update] what's new for v5.2
mafanya23 May 7, 2025
1cf45bf
[add] styled cells borders section into user guide, update related docs
mafanya23 May 8, 2025
bdc2141
[add] freeze/unfreeze cols/rows api, update related guides
mafanya23 May 12, 2025
f48e97f
[update] complete what's new for v5.2
mafanya23 May 13, 2025
d6856e1
[update] what's new for v5.2
mafanya23 May 13, 2025
f9f23f2
[update] what's new for v5.2, add a draft for migration guide
mafanya23 May 13, 2025
7b18e52
[add] hiding/showing cols/rows api, update related guides
mafanya23 May 14, 2025
8a1db65
[add] the afterdataloaded event page, update what's new for v5.2
mafanya23 May 14, 2025
83f2281
[update] freezing/unfreezing rows/cols section in the user guide
mafanya23 May 14, 2025
5ddf272
Merge pull request #17 from DHTMLX/5.2
mafanya23 May 15, 2025
151c1fd
Merge branch 'next' into toolbar-restructuring-4915
mafanya23 May 15, 2025
3319fc1
Merge pull request #18 from DHTMLX/toolbar-restructuring-4915
mafanya23 May 15, 2025
98b10f2
Merge pull request #19 from DHTMLX/freezing-columns-and-rows-3667
mafanya23 May 15, 2025
9958f2b
Merge branch 'next' into cols-rows-hiding-showing-4353
mafanya23 May 15, 2025
db61955
Merge pull request #20 from DHTMLX/cols-rows-hiding-showing-4353
mafanya23 May 15, 2025
cc0223f
Merge pull request #21 from DHTMLX/styled-border-for-cells-3792
mafanya23 May 15, 2025
fdf9bf2
Merge pull request #22 from DHTMLX/formulas-descriptions-popup-4885
mafanya23 May 15, 2025
5fc4bab
[update] correct and complete docs for v5.2
mafanya23 May 15, 2025
dfdd62e
[update] what's new for v 5.2
mafanya23 May 15, 2025
38177cc
[update] correct and complete docs for v5.2
mafanya23 May 16, 2025
7d82da3
[update] correct and complete docs for v5.2
mafanya23 May 16, 2025
fee8e03
[update] the user guide on work with rows and columns
mafanya23 May 19, 2025
bd4337b
[update] minor corrections and improvements in docs for v5.2
mafanya23 May 19, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions docs/api/api_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,17 @@ Parameters:
| [](api/spreadsheet_eachcell_method.md) | @getshort(api/spreadsheet_eachcell_method.md) |
| [](api/spreadsheet_endedit_method.md) | @getshort(api/spreadsheet_endedit_method.md) |
| [](api/spreadsheet_fitcolumn_method.md) | @getshort(api/spreadsheet_fitcolumn_method.md) |
| [](api/spreadsheet_freezecols_method.md) | @getshort(api/spreadsheet_freezecols_method.md) |
| [](api/spreadsheet_freezerows_method.md) | @getshort(api/spreadsheet_freezerows_method.md) |
| [](api/spreadsheet_getactivesheet_method.md) | @getshort(api/spreadsheet_getactivesheet_method.md) |
| [](api/spreadsheet_getfilter_method.md) | @getshort(api/spreadsheet_getfilter_method.md) |
| [](api/spreadsheet_getformat_method.md) | @getshort(api/spreadsheet_getformat_method.md) |
| [](api/spreadsheet_getformula_method.md) | @getshort(api/spreadsheet_getformula_method.md) |
| [](api/spreadsheet_getsheets_method.md) | @getshort(api/spreadsheet_getsheets_method.md) |
| [](api/spreadsheet_getstyle_method.md) | @getshort(api/spreadsheet_getstyle_method.md) |
| [](api/spreadsheet_getvalue_method.md) | @getshort(api/spreadsheet_getvalue_method.md) |
| [](api/spreadsheet_hidecols_method.md) | @getshort(api/spreadsheet_hidecols_method.md) |
| [](api/spreadsheet_hiderows_method.md) | @getshort(api/spreadsheet_hiderows_method.md) |
| [](api/spreadsheet_hidesearch_method.md) | @getshort(api/spreadsheet_hidesearch_method.md) |
| [](api/spreadsheet_insertlink_method.md) | @getshort(api/spreadsheet_insertlink_method.md) |
| [](api/spreadsheet_islocked_method.md) | @getshort(api/spreadsheet_islocked_method.md) |
Expand All @@ -58,8 +62,12 @@ Parameters:
| [](api/spreadsheet_setstyle_method.md) | @getshort(api/spreadsheet_setstyle_method.md) |
| [](api/spreadsheet_setvalidation_method.md) | @getshort(api/spreadsheet_setvalidation_method.md) |
| [](api/spreadsheet_setvalue_method.md) | @getshort(api/spreadsheet_setvalue_method.md) |
| [](api/spreadsheet_showcols_method.md) | @getshort(api/spreadsheet_showcols_method.md) |
| [](api/spreadsheet_showrows_method.md) | @getshort(api/spreadsheet_showrows_method.md) |
| [](api/spreadsheet_startedit_method.md) | @getshort(api/spreadsheet_startedit_method.md) |
| [](api/spreadsheet_undo_method.md) | @getshort(api/spreadsheet_undo_method.md) |
| [](api/spreadsheet_unfreezecols_method.md) | @getshort(api/spreadsheet_unfreezecols_method.md) |
| [](api/spreadsheet_unfreezerows_method.md) | @getshort(api/spreadsheet_unfreezerows_method.md) |
| [](api/spreadsheet_unlock_method.md) | @getshort(api/spreadsheet_unlock_method.md) |

## Spreadsheet events
Expand All @@ -70,6 +78,7 @@ Parameters:
| [](api/spreadsheet_afterclear_event.md) | @getshort(api/spreadsheet_afterclear_event.md) |
| [](api/spreadsheet_aftercolumnadd_event.md) | @getshort(api/spreadsheet_aftercolumnadd_event.md) |
| [](api/spreadsheet_aftercolumndelete_event.md) | @getshort(api/spreadsheet_aftercolumndelete_event.md) |
| [](api/spreadsheet_afterdataloaded_event.md) | @getshort(api/spreadsheet_afterdataloaded_event.md) |
| [](api/spreadsheet_aftereditend_event.md) | @getshort(api/spreadsheet_aftereditend_event.md) |
| [](api/spreadsheet_aftereditstart_event.md) | @getshort(api/spreadsheet_aftereditstart_event.md) |
| [](api/spreadsheet_afterfocusset_event.md) | @getshort(api/spreadsheet_afterfocusset_event.md) |
Expand Down Expand Up @@ -113,15 +122,14 @@ Parameters:
| [](api/spreadsheet_exportmodulepath_config.md) | @getshort(api/spreadsheet_exportmodulepath_config.md) |
| [](api/spreadsheet_formats_config.md) | @getshort(api/spreadsheet_formats_config.md) |
| [](api/spreadsheet_importmodulepath_config.md) | @getshort(api/spreadsheet_importmodulepath_config.md) |
| [](api/spreadsheet_leftsplit_config.md) | @getshort(api/spreadsheet_leftsplit_config.md) |
| [](api/spreadsheet_localization_config.md) | @getshort(api/spreadsheet_localization_config.md) |
| [](api/spreadsheet_menu_config.md) | @getshort(api/spreadsheet_menu_config.md) |
| [](api/spreadsheet_multisheets_config.md) | @getshort(api/spreadsheet_multisheets_config.md) |
| [](api/spreadsheet_readonly_config.md) | @getshort(api/spreadsheet_readonly_config.md) |
| [](api/spreadsheet_rowscount_config.md) | @getshort(api/spreadsheet_rowscount_config.md) |
| [](api/spreadsheet_timeformat_config.md) | @getshort(api/spreadsheet_timeformat_config.md) |
| [](api/spreadsheet_toolbarblocks_config.md) | @getshort(api/spreadsheet_toolbarblocks_config.md) |
| [](api/spreadsheet_topsplit_config.md) | @getshort(api/spreadsheet_topsplit_config.md) |


## Selection methods

Expand Down
3 changes: 3 additions & 0 deletions docs/api/overview/actions_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,13 @@ spreadsheet.events.on("beforeColumnAdd", function(cell){
| **setValidation** | The action is executed when setting data validation for a cell |
| **sortCells** | The action is executed when sorting data in spreadsheet |
| **setCellStyle** | The action is executed when changing the style of a cell |
| **toggleVisibility** | The action is executed when hiding/showing columns/rows |
| **toggleFreeze** | The action is executed when freezing/unfreezing columns/rows |
| **unmerge** | The action is executed when splitting cells |

**Change log:**

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

**Related sample:** [Spreadsheet. Actions](https://snippet.dhtmlx.com/efcuxlkt)
1 change: 1 addition & 0 deletions docs/api/overview/events_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ description: You can have an Events overview of the DHTMLX JavaScript Spreadshee
| [](../spreadsheet_afterclear_event.md) | @getshort(../spreadsheet_afterclear_event.md) |
| [](../spreadsheet_aftercolumnadd_event.md) | @getshort(../spreadsheet_aftercolumnadd_event.md) |
| [](../spreadsheet_aftercolumndelete_event.md) | @getshort(../spreadsheet_aftercolumndelete_event.md) |
| [](../spreadsheet_afterdataloaded_event.md) | @getshort(../spreadsheet_afterdataloaded_event.md) |
| [](../spreadsheet_aftereditend_event.md) | @getshort(../spreadsheet_aftereditend_event.md) |
| [](../spreadsheet_aftereditstart_event.md) | @getshort(../spreadsheet_aftereditstart_event.md) |
| [](../spreadsheet_afterfocusset_event.md) | @getshort(../spreadsheet_afterfocusset_event.md) |
Expand Down
8 changes: 8 additions & 0 deletions docs/api/overview/methods_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,16 @@ description: You can have a Methods overview of the DHTMLX JavaScript Spreadshee
| [](../spreadsheet_eachcell_method.md) | @getshort(../spreadsheet_eachcell_method.md) |
| [](../spreadsheet_endedit_method.md) | @getshort(../spreadsheet_endedit_method.md) |
| [](../spreadsheet_fitcolumn_method.md) | @getshort(../spreadsheet_fitcolumn_method.md) |
| [](../spreadsheet_freezecols_method.md) | @getshort(../spreadsheet_freezecols_method.md) |
| [](../spreadsheet_freezerows_method.md) | @getshort(../spreadsheet_freezerows_method.md) |
| [](../spreadsheet_getactivesheet_method.md) | @getshort(../spreadsheet_getactivesheet_method.md) |
| [](../spreadsheet_getfilter_method.md) | @getshort(../spreadsheet_getfilter_method.md) |
| [](../spreadsheet_getformat_method.md) | @getshort(../spreadsheet_getformat_method.md) |
| [](../spreadsheet_getformula_method.md) | @getshort(../spreadsheet_getformula_method.md) |
| [](../spreadsheet_getsheets_method.md) | @getshort(../spreadsheet_getsheets_method.md) |
| [](../spreadsheet_getstyle_method.md) | @getshort(../spreadsheet_getstyle_method.md) |
| [](../spreadsheet_hidecols_method.md) | @getshort(../spreadsheet_hidecols_method.md) |
| [](../spreadsheet_hiderows_method.md) | @getshort(../spreadsheet_hiderows_method.md) |
| [](../spreadsheet_hidesearch_method.md) | @getshort(../spreadsheet_hidesearch_method.md) |
| [](../spreadsheet_getvalue_method.md) | @getshort(../spreadsheet_getvalue_method.md) |
| [](../spreadsheet_insertlink_method.md) | @getshort(../spreadsheet_insertlink_method.md) |
Expand All @@ -42,6 +46,10 @@ description: You can have a Methods overview of the DHTMLX JavaScript Spreadshee
| [](../spreadsheet_setstyle_method.md) | @getshort(../spreadsheet_setstyle_method.md) |
| [](../spreadsheet_setvalidation_method.md) | @getshort(../spreadsheet_setvalidation_method.md) |
| [](../spreadsheet_setvalue_method.md) | @getshort(../spreadsheet_setvalue_method.md) |
| [](../spreadsheet_showcols_method.md) | @getshort(../spreadsheet_showcols_method.md) |
| [](../spreadsheet_showrows_method.md) | @getshort(../spreadsheet_showrows_method.md) |
| [](../spreadsheet_startedit_method.md) | @getshort(../spreadsheet_startedit_method.md) |
| [](../spreadsheet_undo_method.md) | @getshort(../spreadsheet_undo_method.md) |
| [](../spreadsheet_unfreezecols_method.md) | @getshort(../spreadsheet_unfreezecols_method.md) |
| [](../spreadsheet_unfreezerows_method.md) | @getshort(../spreadsheet_unfreezerows_method.md) |
| [](../spreadsheet_unlock_method.md) | @getshort(../spreadsheet_unlock_method.md) |
3 changes: 1 addition & 2 deletions docs/api/overview/properties_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,11 @@ description: You can have a Properties overview of the DHTMLX JavaScript Spreads
| [](../spreadsheet_exportmodulepath_config.md) | @getshort(../spreadsheet_exportmodulepath_config.md) |
| [](../spreadsheet_formats_config.md) | @getshort(../spreadsheet_formats_config.md) |
| [](../spreadsheet_importmodulepath_config.md) | @getshort(../spreadsheet_importmodulepath_config.md) |
| [](../spreadsheet_leftsplit_config.md) | @getshort(../spreadsheet_leftsplit_config.md) |
| [](../spreadsheet_localization_config.md) | @getshort(../spreadsheet_localization_config.md) |
| [](../spreadsheet_menu_config.md) | @getshort(../spreadsheet_menu_config.md) |
| [](../spreadsheet_multisheets_config.md) | @getshort(../spreadsheet_multisheets_config.md) |
| [](../spreadsheet_readonly_config.md) | @getshort(../spreadsheet_readonly_config.md) |
| [](../spreadsheet_rowscount_config.md) | @getshort(../spreadsheet_rowscount_config.md) |
| [](../spreadsheet_timeformat_config.md) | @getshort(../spreadsheet_timeformat_config.md) |
| [](../spreadsheet_toolbarblocks_config.md) | @getshort(../spreadsheet_toolbarblocks_config.md) |
| [](../spreadsheet_topsplit_config.md) | @getshort(../spreadsheet_topsplit_config.md) |

40 changes: 40 additions & 0 deletions docs/api/spreadsheet_afterdataloaded_event.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
sidebar_label: afterDataLoaded
title: afterDataLoaded event
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.
---

# afterDataLoaded

### Description

@short: Fires after data loading is complete

### Usage

~~~jsx
afterDataLoaded: () => void;
~~~

### Example

~~~jsx
const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", {});
spreadsheet.parse(data);

// subscribe to the "afterDataLoaded" event
spreadsheet.events.on("afterDataLoaded", () => {
dhx.message({
text: "Data is successfully loaded into Spreadsheet!",
css: "dhx_message--success",
expire: 5000
});
});
~~~

**Change log:** Added in v5.2

**Related articles:** [Event handling](handling_events.md)

**Related sample:** [Spreadsheet. Data loaded event](https://snippet.dhtmlx.com/vxr7amz6)

37 changes: 37 additions & 0 deletions docs/api/spreadsheet_freezecols_method.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
sidebar_label: freezeCols()
title: freezeCols method
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.
---

# freezeCols()

### Description

@short: Fixes ("freezes") columns

### Usage

~~~jsx
freezeCols(cell?: string): void;
~~~

### Parameters

- `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

### Example

~~~jsx
spreadsheet.freezeCols("B2"); // the columns up to the "B" column will be fixed
spreadsheet.freezeCols("sheet2!B2"); // the columns up to the "B" column in "sheet2" will be fixed
~~~

**Related articles:** [Work with Spreadsheet](working_with_ssheet.md/#freezingunfreezing-rows-and-columns)

**Related API:** [`unfreezeCols()`](api/spreadsheet_unfreezecols_method.md/)

**Related sample:** [Spreadsheet. Freezing columns and rows via API](https://snippet.dhtmlx.com/a12xd1mn)

**Change log:**
Added in v5.2
37 changes: 37 additions & 0 deletions docs/api/spreadsheet_freezerows_method.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
sidebar_label: freezeRows()
title: freezeRows method
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.
---

# freezeRows()

### Description

@short: Fixes ("freezes") rows

### Usage

~~~jsx
freezeRows(cell?: string): void;
~~~

### Parameters

- `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

### Example

~~~jsx
spreadsheet.freezeRows("B2"); // the rows up to the "2" row will be fixed
spreadsheet.freezeRows("sheet2!B2"); // the rows up to the "2" row in "sheet2" will be fixed
~~~

**Related articles:** [Work with Spreadsheet](working_with_ssheet.md/#freezingunfreezing-rows-and-columns)

**Related API:** [`unfreezeRows()`](api/spreadsheet_unfreezerows_method.md/)

**Related sample:** [Spreadsheet. Freezing columns and rows via API](https://snippet.dhtmlx.com/a12xd1mn)

**Change log:**
Added in v5.2
38 changes: 38 additions & 0 deletions docs/api/spreadsheet_hidecols_method.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
sidebar_label: hideCols()
title: hideCols method
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.
---

# hideCols()

### Description

@short: Hides columns

### Usage

~~~jsx
hideCols(cell?: string): void;
~~~

### Parameters

- `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

### Example

~~~jsx
spreadsheet.hideCols("B2"); // the "B" column will be hidden
spreadsheet.hideCols("sheet2!B2"); // the "B" column in "sheet2" will be hidden
spreadsheet.hideCols("B2:C2"); // the "B" and "C" columns will be hidden
~~~


**Related articles:** [Work with Spreadsheet](working_with_ssheet.md/#hidingshowing-rows-and-columns)

**Related API:** [`showCols()`](api/spreadsheet_showcols_method.md)

**Related sample:** [Spreadsheet. Hiding columns and rows via API](https://snippet.dhtmlx.com/zere1ote)

**Change log:** Added in v5.2
37 changes: 37 additions & 0 deletions docs/api/spreadsheet_hiderows_method.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
sidebar_label: hideRows()
title: hideRows method
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.
---

# hideRows()

### Description

@short: Hides rows

### Usage

~~~jsx
hideRows(cell?: string): void;
~~~

### Parameters

- `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

### Example

~~~jsx
spreadsheet.hideRows("B2"); // the "2" row will be hidden
spreadsheet.hideRows("sheet2!B2"); // the "2" row in "sheet2" will be hidden
spreadsheet.hideRows("B2:C4"); // the rows from "2" to "4" will be hidden
~~~

**Related articles:** [Work with Spreadsheet](working_with_ssheet.md/#hidingshowing-rows-and-columns)

**Related API:** [`showRows()`](api/spreadsheet_showrows_method.md)

**Related sample:** [Spreadsheet. Hiding columns and rows via API](https://snippet.dhtmlx.com/zere1ote)

**Change log:** Added in v5.2
32 changes: 0 additions & 32 deletions docs/api/spreadsheet_leftsplit_config.md

This file was deleted.

Loading
Loading