Skip to content

Add sheet manager module, remove deprecated API, related guides updates #49

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.

Sign up for GitHub

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

Open
mafanya23 wants to merge 7 commits into
base: 6.0
Choose a base branch
from
Open

Add sheet manager module, remove deprecated API, related guides updates #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
09d62f7
[add] sheet manager api, a section on deprecated api, update related …
mafanya23 May 5, 2026
7e9f549
[add] a section on using JSDoc annotations in type definitions
mafanya23 May 6, 2026
51d92b6
[update] complete sheet manager api, remove deprecated methods, fix b…
mafanya23 May 6, 2026
417bbfc
[update] what's new for v6.0, remove date/timeFormat configs, update …
mafanya23 May 6, 2026
2f571b8
[update] remove deprecated events' pages, fix broken links in what's new
mafanya23 May 6, 2026
9b2f3a5
[update] add links to new/updated api into migration guide for v6.0
mafanya23 May 6, 2026
7b4fc3e
[update] styles for deprecated methods table, add overflow instead of…
mafanya23 May 7, 2026
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
44 changes: 13 additions & 31 deletions docs/api/api_overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sidebar_label: API overview
title: API Overview
description: You can have an API overview of the DHTMLX JavaScript Spreadsheet library in the documentation. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Spreadsheet.
description: You can check an API overview of the DHTMLX JavaScript Spreadsheet library in the documentation. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Spreadsheet.
---

# API overview
Expand All @@ -26,21 +26,17 @@ Parameters:
| :------------------------------------------- | :-------------------------------------------------- |
| [](api/spreadsheet_addcolumn_method.md) | @getshort(api/spreadsheet_addcolumn_method.md) |
| [](api/spreadsheet_addrow_method.md) | @getshort(api/spreadsheet_addrow_method.md) |
| [](api/spreadsheet_addsheet_method.md) | @getshort(api/spreadsheet_addsheet_method.md) |
| [](api/spreadsheet_clear_method.md) | @getshort(api/spreadsheet_clear_method.md) |
| [](api/spreadsheet_clearsheet_method.md) | @getshort(api/spreadsheet_clearsheet_method.md) |
| [](api/spreadsheet_deletecolumn_method.md) | @getshort(api/spreadsheet_deletecolumn_method.md) |
| [](api/spreadsheet_deleterow_method.md) | @getshort(api/spreadsheet_deleterow_method.md) |
| [](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) |
Expand All @@ -53,10 +49,8 @@ Parameters:
| [](api/spreadsheet_mergecells_method.md) | @getshort(api/spreadsheet_mergecells_method.md) |
| [](api/spreadsheet_parse_method.md) | @getshort(api/spreadsheet_parse_method.md) |
| [](api/spreadsheet_redo_method.md) | @getshort(api/spreadsheet_redo_method.md) |
| [](api/spreadsheet_removesheet_method.md) | @getshort(api/spreadsheet_removesheet_method.md) |
| [](api/spreadsheet_serialize_method.md) | @getshort(api/spreadsheet_serialize_method.md) |
| [](api/spreadsheet_search_method.md) | @getshort(api/spreadsheet_search_method.md) |
| [](api/spreadsheet_setactivesheet_method.md) | @getshort(api/spreadsheet_setactivesheet_method.md) |
| [](api/spreadsheet_setfilter_method.md) | @getshort(api/spreadsheet_setfilter_method.md) |
| [](api/spreadsheet_setformat_method.md) | @getshort(api/spreadsheet_setformat_method.md) |
| [](api/spreadsheet_setstyle_method.md) | @getshort(api/spreadsheet_setstyle_method.md) |
Expand All @@ -76,48 +70,25 @@ Parameters:
| :---------------------------------------------- | :----------------------------------------------------- |
| [](api/spreadsheet_afteraction_event.md) | @getshort(api/spreadsheet_afteraction_event.md) |
| [](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) |
| [](api/spreadsheet_afterformatchange_event.md) | @getshort(api/spreadsheet_afterformatchange_event.md) |
| [](api/spreadsheet_afterrowadd_event.md) | @getshort(api/spreadsheet_afterrowadd_event.md) |
| [](api/spreadsheet_afterrowdelete_event.md) | @getshort(api/spreadsheet_afterrowdelete_event.md) |
| [](api/spreadsheet_afterselectionset_event.md) | @getshort(api/spreadsheet_afterselectionset_event.md) |
| [](api/spreadsheet_aftersheetadd_event.md) | @getshort(api/spreadsheet_aftersheetadd_event.md) |
| [](api/spreadsheet_aftersheetchange_event.md) | @getshort(api/spreadsheet_aftersheetchange_event.md) |
| [](api/spreadsheet_aftersheetclear_event.md) | @getshort(api/spreadsheet_aftersheetclear_event.md) |
| [](api/spreadsheet_aftersheetremove_event.md) | @getshort(api/spreadsheet_aftersheetremove_event.md) |
| [](api/spreadsheet_aftersheetrename_event.md) | @getshort(api/spreadsheet_aftersheetrename_event.md) |
| [](api/spreadsheet_afterstylechange_event.md) | @getshort(api/spreadsheet_afterstylechange_event.md) |
| [](api/spreadsheet_aftervaluechange_event.md) | @getshort(api/spreadsheet_aftervaluechange_event.md) |
| [](api/spreadsheet_beforeaction_event.md) | @getshort(api/spreadsheet_beforeaction_event.md) |
| [](api/spreadsheet_beforeclear_event.md) | @getshort(api/spreadsheet_beforeclear_event.md) |
| [](api/spreadsheet_beforecolumnadd_event.md) | @getshort(api/spreadsheet_beforecolumnadd_event.md) |
| [](api/spreadsheet_beforecolumndelete_event.md) | @getshort(api/spreadsheet_beforecolumndelete_event.md) |
| [](api/spreadsheet_beforeeditend_event.md) | @getshort(api/spreadsheet_beforeeditend_event.md) |
| [](api/spreadsheet_beforeeditstart_event.md) | @getshort(api/spreadsheet_beforeeditstart_event.md) |
| [](api/spreadsheet_beforefocusset_event.md) | @getshort(api/spreadsheet_beforefocusset_event.md) |
| [](api/spreadsheet_beforeformatchange_event.md) | @getshort(api/spreadsheet_beforeformatchange_event.md) |
| [](api/spreadsheet_beforerowadd_event.md) | @getshort(api/spreadsheet_beforerowadd_event.md) |
| [](api/spreadsheet_beforerowdelete_event.md) | @getshort(api/spreadsheet_beforerowdelete_event.md) |
| [](api/spreadsheet_beforeselectionset_event.md) | @getshort(api/spreadsheet_beforeselectionset_event.md) |
| [](api/spreadsheet_beforesheetadd_event.md) | @getshort(api/spreadsheet_beforesheetadd_event.md) |
| [](api/spreadsheet_beforesheetchange_event.md) | @getshort(api/spreadsheet_beforesheetchange_event.md) |
| [](api/spreadsheet_beforesheetclear_event.md) | @getshort(api/spreadsheet_beforesheetclear_event.md) |
| [](api/spreadsheet_beforesheetremove_event.md) | @getshort(api/spreadsheet_beforesheetremove_event.md) |
| [](api/spreadsheet_beforesheetrename_event.md) | @getshort(api/spreadsheet_beforesheetrename_event.md) |
| [](api/spreadsheet_beforestylechange_event.md) | @getshort(api/spreadsheet_beforestylechange_event.md) |
| [](api/spreadsheet_beforevaluechange_event.md) | @getshort(api/spreadsheet_beforevaluechange_event.md) |

## Spreadsheet properties

| Name | Description |
| ---------------------------------------------- | ----------------------------------------------------- |
| [](api/spreadsheet_colscount_config.md) | @getshort(api/spreadsheet_colscount_config.md) |
| [](api/spreadsheet_dateformat_config.md) | @getshort(api/spreadsheet_dateformat_config.md) |
| [](api/spreadsheet_editline_config.md) | @getshort(api/spreadsheet_editline_config.md) |
| [](api/spreadsheet_exportmodulepath_config.md) | @getshort(api/spreadsheet_exportmodulepath_config.md) |
| [](api/spreadsheet_formats_config.md) | @getshort(api/spreadsheet_formats_config.md) |
Expand All @@ -127,10 +98,21 @@ Parameters:
| [](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) |


## Sheet Manager methods

| Name | Description |
| :---------------------------------------- | :----------------------------------------------- |
| [](api/sheetmanager_add_method.md) | @getshort(api/sheetmanager_add_method.md) |
| [](api/sheetmanager_clear_method.md) | @getshort(api/sheetmanager_clear_method.md) |
| [](api/sheetmanager_get_method.md) | @getshort(api/sheetmanager_get_method.md) |
| [](api/sheetmanager_getactive_method.md) | @getshort(api/sheetmanager_getactive_method.md) |
| [](api/sheetmanager_getall_method.md) | @getshort(api/sheetmanager_getall_method.md) |
| [](api/sheetmanager_remove_method.md) | @getshort(api/sheetmanager_remove_method.md) |
| [](api/sheetmanager_setactive_method.md) | @getshort(api/sheetmanager_setactive_method.md) |

## Selection methods

| Name | Description |
Expand Down
4 changes: 2 additions & 2 deletions docs/api/overview/actions_overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sidebar_label: Spreadsheet actions
title: Actions Overview
description: You can have an Actions overview of the DHTMLX JavaScript Spreadsheet library in the documentation. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Spreadsheet.
description: You can check an Actions overview of the DHTMLX JavaScript Spreadsheet library in the documentation. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Spreadsheet.
---

# Actions overview
Expand Down Expand Up @@ -55,7 +55,7 @@ spreadsheet.events.on("beforeColumnAdd", function(cell){
| **addRow** | The action is executed when adding a new row |
| **addSheet** | The action is executed when adding a new sheet |
| **clear** | The action is executed when clearing the spreadsheet via the <b>clear()</b> method |
| **clearSheet** | The action is executed when clearing a sheet via the <b>clearSheet()</b> method |
| **clearSheet** | The action is executed when clearing a sheet via the <b>sheets.clear()</b> method |
| **deleteColumn** | The action is executed when removing a column |
| **deleteRow** | The action is executed when removing a row |
| **deleteSheet** | The action is executed when removing a sheet |
Expand Down
2 changes: 1 addition & 1 deletion docs/api/overview/eventbus_overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sidebar_label: Event Bus methods overview
title: Event Bus Methods Overview
description: You can have an Event Bus methods overview of the DHTMLX JavaScript Spreadsheet library in the documentation. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Spreadsheet.
description: You can check an Event Bus methods overview of the DHTMLX JavaScript Spreadsheet library in the documentation. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Spreadsheet.
---

# Event Bus methods overview
Expand Down
26 changes: 2 additions & 24 deletions docs/api/overview/events_overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,38 +10,16 @@ description: You can have an Events overview of the DHTMLX JavaScript Spreadshee
| :--------------------------------------------- | :---------------------------------------------------- |
| [](../spreadsheet_afteraction_event.md) | @getshort(../spreadsheet_afteraction_event.md) |
| [](../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_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) |
| [](../spreadsheet_afterformatchange_event.md) | @getshort(../spreadsheet_afterformatchange_event.md) |
| [](../spreadsheet_afterrowadd_event.md) | @getshort(../spreadsheet_afterrowadd_event.md) |
| [](../spreadsheet_afterrowdelete_event.md) | @getshort(../spreadsheet_afterrowdelete_event.md) |
| [](../spreadsheet_afterselectionset_event.md) | @getshort(../spreadsheet_afterselectionset_event.md) |
| [](../spreadsheet_aftersheetadd_event.md) | @getshort(../spreadsheet_aftersheetadd_event.md) |
| [](../spreadsheet_aftersheetchange_event.md) | @getshort(../spreadsheet_aftersheetchange_event.md) |
| [](../spreadsheet_aftersheetclear_event.md) | @getshort(../spreadsheet_aftersheetclear_event.md) |
| [](../spreadsheet_aftersheetremove_event.md) | @getshort(../spreadsheet_aftersheetremove_event.md) |
| [](../spreadsheet_aftersheetrename_event.md) | @getshort(../spreadsheet_aftersheetrename_event.md) |
| [](../spreadsheet_afterstylechange_event.md) | @getshort(../spreadsheet_afterstylechange_event.md) |
| [](../spreadsheet_aftervaluechange_event.md) | @getshort(../spreadsheet_aftervaluechange_event.md) |
| [](../spreadsheet_beforeaction_event.md) | @getshort(../spreadsheet_beforeaction_event.md) |
| [](../spreadsheet_beforeclear_event.md) | @getshort(../spreadsheet_beforeclear_event.md) |
| [](../spreadsheet_beforecolumnadd_event.md) | @getshort(../spreadsheet_beforecolumnadd_event.md) |
| [](../spreadsheet_beforecolumndelete_event.md) | @getshort(../spreadsheet_beforecolumndelete_event.md) |
| [](../spreadsheet_beforeeditend_event.md) | @getshort(../spreadsheet_beforeeditend_event.md) |
| [](../spreadsheet_beforeeditstart_event.md) | @getshort(../spreadsheet_beforeeditstart_event.md) |
| [](../spreadsheet_beforefocusset_event.md) | @getshort(../spreadsheet_beforefocusset_event.md) |
| [](../spreadsheet_beforeformatchange_event.md) | @getshort(../spreadsheet_beforeformatchange_event.md) |
| [](../spreadsheet_beforerowadd_event.md) | @getshort(../spreadsheet_beforerowadd_event.md) |
| [](../spreadsheet_beforerowdelete_event.md) | @getshort(../spreadsheet_beforerowdelete_event.md) |
| [](../spreadsheet_beforeselectionset_event.md) | @getshort(../spreadsheet_beforeselectionset_event.md) |
| [](../spreadsheet_beforesheetadd_event.md) | @getshort(../spreadsheet_beforesheetadd_event.md) |
| [](../spreadsheet_beforesheetchange_event.md) | @getshort(../spreadsheet_beforesheetchange_event.md) |
| [](../spreadsheet_beforesheetclear_event.md) | @getshort(../spreadsheet_beforesheetclear_event.md) |
| [](../spreadsheet_beforesheetremove_event.md) | @getshort(../spreadsheet_beforesheetremove_event.md) |
| [](../spreadsheet_beforesheetrename_event.md) | @getshort(../spreadsheet_beforesheetrename_event.md) |
| [](../spreadsheet_beforestylechange_event.md) | @getshort(../spreadsheet_beforestylechange_event.md) |
| [](../spreadsheet_beforevaluechange_event.md) | @getshort(../spreadsheet_beforevaluechange_event.md) |
| [](../spreadsheet_beforesheetchange_event.md) | @getshort(../spreadsheet_beforesheetchange_event.md) |
2 changes: 1 addition & 1 deletion docs/api/overview/export_overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sidebar_label: Export methods overview
title: Export Methods Overview
description: You can have an Export methods overview of the DHTMLX JavaScript Spreadsheet library in the documentation. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Spreadsheet.
description: You can check an Export methods overview of the DHTMLX JavaScript Spreadsheet library in the documentation. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Spreadsheet.
---

# Export methods overview
Expand Down
Loading