diff --git a/docs/api/api_overview.md b/docs/api/api_overview.md index 498b7e9d..0175f562 100644 --- a/docs/api/api_overview.md +++ b/docs/api/api_overview.md @@ -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 @@ -26,9 +26,7 @@ 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) | @@ -36,11 +34,9 @@ Parameters: | [](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) | @@ -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) | @@ -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) | @@ -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 | diff --git a/docs/api/overview/actions_overview.md b/docs/api/overview/actions_overview.md index 5f30c1cb..6377e0d4 100644 --- a/docs/api/overview/actions_overview.md +++ b/docs/api/overview/actions_overview.md @@ -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 @@ -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 clear() method | -| **clearSheet** | The action is executed when clearing a sheet via the clearSheet() method | +| **clearSheet** | The action is executed when clearing a sheet via the sheets.clear() 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 | diff --git a/docs/api/overview/eventbus_overview.md b/docs/api/overview/eventbus_overview.md index 6e2a1b4e..4c76f9c2 100644 --- a/docs/api/overview/eventbus_overview.md +++ b/docs/api/overview/eventbus_overview.md @@ -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 diff --git a/docs/api/overview/events_overview.md b/docs/api/overview/events_overview.md index 11a4ea39..b2fc3887 100644 --- a/docs/api/overview/events_overview.md +++ b/docs/api/overview/events_overview.md @@ -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) | \ No newline at end of file +| [](../spreadsheet_beforesheetchange_event.md) | @getshort(../spreadsheet_beforesheetchange_event.md) | \ No newline at end of file diff --git a/docs/api/overview/export_overview.md b/docs/api/overview/export_overview.md index a5206b74..5a9586b6 100644 --- a/docs/api/overview/export_overview.md +++ b/docs/api/overview/export_overview.md @@ -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 diff --git a/docs/api/overview/methods_overview.md b/docs/api/overview/methods_overview.md index 6074a75e..c879cc8e 100644 --- a/docs/api/overview/methods_overview.md +++ b/docs/api/overview/methods_overview.md @@ -1,7 +1,7 @@ --- sidebar_label: Methods overview title: Methods Overview -description: You can have a 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 a 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. --- # Methods overview @@ -10,9 +10,7 @@ description: You can have a Methods overview of the DHTMLX JavaScript Spreadshee | :------------------------------------------ | :------------------------------------------------- | | [](../spreadsheet_addcolumn_method.md) | @getshort(../spreadsheet_addcolumn_method.md) | | [](../spreadsheet_addrow_method.md) | @getshort(../spreadsheet_addrow_method.md) | -| [](../spreadsheet_addsheet_method.md) | @getshort(../spreadsheet_addsheet_method.md) | | [](../spreadsheet_clear_method.md) | @getshort(../spreadsheet_clear_method.md) | -| [](../spreadsheet_clearsheet_method.md) | @getshort(../spreadsheet_clearsheet_method.md) | | [](../spreadsheet_deletecolumn_method.md) | @getshort(../spreadsheet_deletecolumn_method.md) | | [](../spreadsheet_deleterow_method.md) | @getshort(../spreadsheet_deleterow_method.md) | | [](../spreadsheet_eachcell_method.md) | @getshort(../spreadsheet_eachcell_method.md) | @@ -20,11 +18,9 @@ description: You can have a Methods overview of the DHTMLX JavaScript Spreadshee | [](../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) | @@ -37,10 +33,8 @@ description: You can have a Methods overview of the DHTMLX JavaScript Spreadshee | [](../spreadsheet_mergecells_method.md) | @getshort(../spreadsheet_mergecells_method.md) | | [](../spreadsheet_parse_method.md) | @getshort(../spreadsheet_parse_method.md) | | [](../spreadsheet_redo_method.md) | @getshort(../spreadsheet_redo_method.md) | -| [](../spreadsheet_removesheet_method.md) | @getshort(../spreadsheet_removesheet_method.md) | | [](../spreadsheet_search_method.md) | @getshort(../spreadsheet_search_method.md) | | [](../spreadsheet_serialize_method.md) | @getshort(../spreadsheet_serialize_method.md) | -| [](../spreadsheet_setactivesheet_method.md) | @getshort(../spreadsheet_setactivesheet_method.md) | | [](../spreadsheet_setfilter_method.md) | @getshort(../spreadsheet_setfilter_method.md) | | [](../spreadsheet_setformat_method.md) | @getshort(../spreadsheet_setformat_method.md) | | [](../spreadsheet_setstyle_method.md) | @getshort(../spreadsheet_setstyle_method.md) | diff --git a/docs/api/overview/properties_overview.md b/docs/api/overview/properties_overview.md index c0689b28..c3b89a1f 100644 --- a/docs/api/overview/properties_overview.md +++ b/docs/api/overview/properties_overview.md @@ -1,7 +1,7 @@ --- sidebar_label: Properties overview title: Properties Overview -description: You can have a Properties 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 a Properties 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. --- # Properties overview @@ -9,7 +9,6 @@ description: You can have a Properties overview of the DHTMLX JavaScript Spreads | Name | Description | | --------------------------------------------- | ---------------------------------------------------- | | [](../spreadsheet_colscount_config.md) | @getshort(../spreadsheet_colscount_config.md) | -| [](../spreadsheet_dateformat_config.md) | @getshort(../spreadsheet_dateformat_config.md) | | [](../spreadsheet_editline_config.md) | @getshort(../spreadsheet_editline_config.md) | | [](../spreadsheet_exportmodulepath_config.md) | @getshort(../spreadsheet_exportmodulepath_config.md) | | [](../spreadsheet_formats_config.md) | @getshort(../spreadsheet_formats_config.md) | @@ -19,6 +18,5 @@ description: You can have a Properties overview of the DHTMLX JavaScript Spreads | [](../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) | diff --git a/docs/api/overview/selection_overview.md b/docs/api/overview/selection_overview.md index f8ff6fe3..8310e875 100644 --- a/docs/api/overview/selection_overview.md +++ b/docs/api/overview/selection_overview.md @@ -1,7 +1,7 @@ --- sidebar_label: Selection methods overview title: Selection Methods Overview -description: You can have a Selection 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 a Selection 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. --- # Selection methods overview diff --git a/docs/api/overview/sheetmanager_overview.md b/docs/api/overview/sheetmanager_overview.md new file mode 100644 index 00000000..d2247905 --- /dev/null +++ b/docs/api/overview/sheetmanager_overview.md @@ -0,0 +1,17 @@ +--- +sidebar_label: Sheet Manager API overview +title: Sheet Manager API Overview +description: You can check a Sheet Manager 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. +--- + +# Sheet Manager API overview + +| Name | Description | +| :---------------------------------------- | :----------------------------------------------- | +| [](../sheetmanager_add_method.md) | @getshort(../sheetmanager_add_method.md) | +| [](../sheetmanager_clear_method.md) | @getshort(../sheetmanager_clear_method.md) | +| [](../sheetmanager_get_method.md) | @getshort(../sheetmanager_get_method.md) | +| [](../sheetmanager_getactive_method.md) | @getshort(../sheetmanager_getactive_method.md) | +| [](../sheetmanager_getall_method.md) | @getshort(../sheetmanager_getall_method.md) | +| [](../sheetmanager_remove_method.md) | @getshort(../sheetmanager_remove_method.md) | +| [](../sheetmanager_setactive_method.md) | @getshort(../sheetmanager_setactive_method.md) | diff --git a/docs/api/sheetmanager_add_method.md b/docs/api/sheetmanager_add_method.md new file mode 100644 index 00000000..90bde5db --- /dev/null +++ b/docs/api/sheetmanager_add_method.md @@ -0,0 +1,51 @@ +--- +sidebar_label: add() +title: add method +description: You can learn about the add method of the Sheet Manager 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. +--- + +# add() + +### Description + +@short: Adds a new empty sheet to the spreadsheet and returns the unique identifier of the newly created sheet + +If no name is provided, a default name will be generated automatically (e.g. "Sheet 2", "Sheet 3", etc.). + +:::info +To apply this method, you need to enable the [multiSheets](api/spreadsheet_multisheets_config.md) configuration option. +::: + +### Usage + +~~~jsx +add: (name?: string) => Id; +~~~ + +### Parameters + +- `name` - (*string*) optional, the displayed name for the new sheet tab. If omitted, a default name is assigned. + +### Returns + +- `Id` - (*string | number*) the unique identifier of the newly created sheet. + +### Example + +~~~jsx +const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", { + multiSheets: true +}); +spreadsheet.parse(data); + +// Add a sheet with a custom name +const newSheetId = spreadsheet.sheets.add("Q4 Report"); +console.log(newSheetId); // e.g. "sheet_2" + +// Add a sheet with an auto-generated name +const anotherSheetId = spreadsheet.sheets.add(); +~~~ + +**Change log:** Added in v6.0 + +**Related articles:** [Working with sheets](working_with_sheets.md) diff --git a/docs/api/sheetmanager_clear_method.md b/docs/api/sheetmanager_clear_method.md new file mode 100644 index 00000000..014b2753 --- /dev/null +++ b/docs/api/sheetmanager_clear_method.md @@ -0,0 +1,42 @@ +--- +sidebar_label: clear() +title: clear method +description: You can learn about the clear method of the Sheet Manager 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. +--- + +# clear() + +### Description + +@short: Clears the content of a specific sheet (removes all cell values, styles, and formatting) without deleting the sheet itself + +If no id is provided, the currently active sheet is cleared. + +### Usage + +~~~jsx +clear: (id?: Id) => void; +~~~ + +### Parameters + +- `id` - (*string | number*) optional, the unique identifier of the sheet to clear. If omitted, the currently active sheet is cleared. + +### Example + +~~~jsx +const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", { + multiSheets: true +}); +spreadsheet.parse(data); + +// Clear a specific sheet by id +spreadsheet.sheets.clear("sheet_1"); + +// Clear the currently active sheet +spreadsheet.sheets.clear(); +~~~ + +**Change log:** Added in v6.0 + +**Related articles:** [Working with sheets](working_with_sheets.md) diff --git a/docs/api/sheetmanager_get_method.md b/docs/api/sheetmanager_get_method.md new file mode 100644 index 00000000..02b289c9 --- /dev/null +++ b/docs/api/sheetmanager_get_method.md @@ -0,0 +1,41 @@ +--- +sidebar_label: get() +title: get method +description: You can learn about the get method of the Sheet Manager 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. +--- + +# get() + +### Description + +@short: Returns a single sheet object by its identifier + +### Usage + +~~~jsx +get: (id: Id) => ISheet; +~~~ + +### Parameters + +- `id` - (*string | number*) required, the unique identifier of the sheet to retrieve. + +### Returns + +- `ISheet` - (*object*) the sheet object matching the given id. + +### Example + +~~~jsx +const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", { + multiSheets: true +}); +spreadsheet.parse(data); + +const sheet = spreadsheet.sheets.get("sheet_1"); +console.log(sheet.name); // "Sheet 1" +~~~ + +**Change log:** Added in v6.0 + +**Related articles:** [Working with sheets](working_with_sheets.md) diff --git a/docs/api/sheetmanager_getactive_method.md b/docs/api/sheetmanager_getactive_method.md new file mode 100644 index 00000000..c59b0e16 --- /dev/null +++ b/docs/api/sheetmanager_getactive_method.md @@ -0,0 +1,38 @@ +--- +sidebar_label: getActive() +title: getActive method +description: You can learn about the getActive method of the Sheet Manager 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. +--- + +# getActive() + +### Description + +@short: Returns the sheet object that is currently active (visible) in the spreadsheet + +### Usage + +~~~jsx +getActive: () => ISheet; +~~~ + +### Returns + +- `ISheet` - (*object*) the currently active sheet object with the `id` and `name` properties. + +### Example + +~~~jsx +const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", { + multiSheets: true +}); +spreadsheet.parse(data); + +const active = spreadsheet.sheets.getActive(); +console.log(active.name); // "Sheet 1" +console.log(active.id); // "sheet_1" +~~~ + +**Change log:** Added in v6.0 + +**Related articles:** [Working with sheets](working_with_sheets.md) diff --git a/docs/api/sheetmanager_getall_method.md b/docs/api/sheetmanager_getall_method.md new file mode 100644 index 00000000..795b6c4f --- /dev/null +++ b/docs/api/sheetmanager_getall_method.md @@ -0,0 +1,45 @@ +--- +sidebar_label: getAll() +title: getAll method +description: You can learn about the getAll method of the Sheet Manager 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. +--- + +# getAll() + +### Description + +@short: Returns an array of all sheet objects currently present in the spreadsheet + +:::info +Each sheet object contains the sheet's id and name. +::: + +### Usage + +~~~jsx +getAll: () => ISheet[]; +~~~ + +### Returns + +- `ISheet[]` - (*array*) an array of sheet objects. + +### Example + +~~~jsx +const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", { + multiSheets: true +}); +spreadsheet.parse(data); + +const allSheets = spreadsheet.sheets.getAll(); +console.log(allSheets); +// [ +// { id: "sheet_1", name: "Sheet 1" }, +// { id: "sheet_2", name: "Sheet 2" } +// ] +~~~ + +**Change log:** Added in v6.0 + +**Related articles:** [Working with sheets](working_with_sheets.md) diff --git a/docs/api/sheetmanager_remove_method.md b/docs/api/sheetmanager_remove_method.md new file mode 100644 index 00000000..f1d59869 --- /dev/null +++ b/docs/api/sheetmanager_remove_method.md @@ -0,0 +1,45 @@ +--- +sidebar_label: remove() +title: remove method +description: You can learn about the remove method of the Sheet Manager 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. +--- + +# remove() + +### Description + +@short: Removes a sheet from the spreadsheet by its identifier + +If the removed sheet was active, the spreadsheet will automatically switch to another available sheet. + +:::info +To apply this method, you need to enable the [multiSheets](api/spreadsheet_multisheets_config.md) configuration option. + +Also note, that a sheet won't be deleted if the number of sheets in the spreadsheet is less than 2. +::: + +### Usage + +~~~jsx +remove: (id: Id) => void; +~~~ + +### Parameters + +- `id` - (*string | number*) required, the unique identifier of the sheet to remove. + +### Example + +~~~jsx +const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", { + multiSheets: true +}); +spreadsheet.parse(data); + +// Remove a sheet by its id +spreadsheet.sheets.remove("sheet_2"); +~~~ + +**Change log:** Added in v6.0 + +**Related articles:** [Working with sheets](working_with_sheets.md) diff --git a/docs/api/sheetmanager_setactive_method.md b/docs/api/sheetmanager_setactive_method.md new file mode 100644 index 00000000..6b36bebc --- /dev/null +++ b/docs/api/sheetmanager_setactive_method.md @@ -0,0 +1,43 @@ +--- +sidebar_label: setActive() +title: setActive method +description: You can learn about the setActive method of the Sheet Manager 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. +--- + +# setActive() + +### Description + +@short: Switches the active (visible) sheet to the one specified by its identifier + +The spreadsheet UI will re-render to display the target sheet's contents. + +### Usage + +~~~jsx +setActive: (id: Id) => void; +~~~ + +### Parameters + +- `id` - (*string | number*) required, the unique identifier of the sheet to activate. + +### Example + +~~~jsx +const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", { + multiSheets: true +}); +spreadsheet.parse(data); + +// Switch to the second sheet +spreadsheet.sheets.setActive("sheet_2"); + +// Verify the switch +const active = spreadsheet.sheets.getActive(); +console.log(active.name); // "Sheet 2" +~~~ + +**Change log:** Added in v6.0 + +**Related articles:** [Working with sheets](working_with_sheets.md) diff --git a/docs/api/spreadsheet_addsheet_method.md b/docs/api/spreadsheet_addsheet_method.md deleted file mode 100644 index fc1eae98..00000000 --- a/docs/api/spreadsheet_addsheet_method.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -sidebar_label: addSheet() -title: addSheet method -description: You can learn about the addSheet 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. ---- - -# addSheet() - -### Description - -@short: Adds a new sheet into the spreadsheet - -:::info -To apply this method, you need to enable the [multisheets](api/spreadsheet_multisheets_config.md) configuration option. -::: - -### Usage - -~~~jsx -addSheet(name?: string): string; -~~~ - -### Parameters - -- `name` - (optional) the name of the new sheet - -### Returns - -The method returns an id of the new sheet. - -### Example - -~~~jsx {5} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// returns "u1614669331209" -spreadsheet.addSheet("New Sheet"); -~~~ - -**Change log:** Added in v4.1 diff --git a/docs/api/spreadsheet_aftercolumnadd_event.md b/docs/api/spreadsheet_aftercolumnadd_event.md deleted file mode 100644 index 13c64120..00000000 --- a/docs/api/spreadsheet_aftercolumnadd_event.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -sidebar_label: afterColumnAdd -title: afterColumnAdd event -description: You can learn about the afterColumnAdd 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. ---- - -# afterColumnAdd - -:::caution -The **afterColumnAdd** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("afterAction", (actionName, config) => { - if (actionName === "addColumn") { - console.log(actionName, config) - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires after a new column is added - -### Usage - -~~~jsx -afterColumnAdd: (cell: string) => void; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -- `cell` - (required) the id of a cell - -### Example - -~~~jsx {5-8} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "afterColumnAdd" event -spreadsheet.events.on("afterColumnAdd", function(cell){ - console.log("A new column is added"); - console.log(cell); -}); -~~~ - -**Related articles:** [Event handling](handling_events.md) \ No newline at end of file diff --git a/docs/api/spreadsheet_aftercolumndelete_event.md b/docs/api/spreadsheet_aftercolumndelete_event.md deleted file mode 100644 index 237c3929..00000000 --- a/docs/api/spreadsheet_aftercolumndelete_event.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -sidebar_label: afterColumnDelete -title: afterColumnDelete event -description: You can learn about the afterColumnDelete 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. ---- - -# afterColumnDelete - -:::caution -The **afterColumnDelete** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("afterAction", (actionName, config) => { - if (actionName === "deleteColumn") { - console.log(actionName, config) - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires after a column is deleted - -### Usage - -~~~jsx -afterColumnDelete: (cell: string) => void; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -- `cell` - (required) the id of a cell - -### Example - -~~~jsx {5-8} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "afterColumnDelete" event -spreadsheet.events.on("afterColumnDelete", function(cell){ - console.log("A column was deleted"); - console.log(cell); -}); -~~~ - -**Related articles:** [Event handling](handling_events.md) \ No newline at end of file diff --git a/docs/api/spreadsheet_afterformatchange_event.md b/docs/api/spreadsheet_afterformatchange_event.md deleted file mode 100644 index 13206d09..00000000 --- a/docs/api/spreadsheet_afterformatchange_event.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_label: afterFormatChange -title: afterFormatChange event -description: You can learn about the afterFormatChange 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. ---- - -# afterFormatChange - -:::caution -The **afterFormatChange** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("afterAction", (actionName, config) => { - if (actionName === "setCellFormat") { - console.log(actionName, config); - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires after the format of a cell is changed - -### Usage - -~~~jsx -afterFormatChange: (cell: string, format: string) => void; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -- `cell` - (required) the id of a cell -- `format` - (required) a new format applied for a cell - -### Example - -~~~jsx {5-8} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "afterFormatChange" event -spreadsheet.events.on("afterFormatChange", function(cell, format){ - console.log("Format of cell "+spreadsheet.selection.getSelectedCell()+" has changed"); - console.log(cell, format); -}); -~~~ - -**Related articles:** -- [Number formatting](number_formatting.md) -- [Event handling](handling_events.md) - -**Related sample:** [Spreadsheet. Events](https://snippet.dhtmlx.com/2vkjyvsi) \ No newline at end of file diff --git a/docs/api/spreadsheet_afterrowadd_event.md b/docs/api/spreadsheet_afterrowadd_event.md deleted file mode 100644 index aec50350..00000000 --- a/docs/api/spreadsheet_afterrowadd_event.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -sidebar_label: afterRowAdd -title: afterRowAdd event -description: You can learn about the afterRowAdd 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. ---- - -# afterRowAdd - -:::caution -The **afterRowAdd** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("afterAction", (actionName, config) => { - if (actionName === "addRow") { - console.log(actionName, config); - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires after a new row is added - -### Usage - -~~~jsx -afterRowAdd: (cell: string) => void; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -- `cell` - (required) the id of a cell - -### Example - -~~~jsx {5-8} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "afterRowAdd" event -spreadsheet.events.on("afterRowAdd", function(cell){ - console.log("A new row is added"); - console.log(cell); -}); -~~~ - -**Related articles:** [Event handling](handling_events.md) \ No newline at end of file diff --git a/docs/api/spreadsheet_afterrowdelete_event.md b/docs/api/spreadsheet_afterrowdelete_event.md deleted file mode 100644 index 58cfda19..00000000 --- a/docs/api/spreadsheet_afterrowdelete_event.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -sidebar_label: afterRowDelete -title: afterRowDelete event -description: You can learn about the afterRowDelete 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. ---- - -# afterRowDelete - -:::caution -The **afterRowDelete** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("afterAction", (actionName, config) => { - if (actionName === "deleteRow") { - console.log(actionName, config); - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires after a row is deleted - -### Usage - -~~~jsx -afterRowDelete: (cell: string) => void; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -- `cell` - (required) the id of a cell - -### Example - -~~~jsx {5-8} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "afterRowDelete" event -spreadsheet.events.on("afterRowDelete", function(cell){ - console.log("A row was deleted"); - console.log(cell); -}); -~~~ - -**Related articles:** [Event handling](handling_events.md) \ No newline at end of file diff --git a/docs/api/spreadsheet_aftersheetadd_event.md b/docs/api/spreadsheet_aftersheetadd_event.md deleted file mode 100644 index 9d61e2a9..00000000 --- a/docs/api/spreadsheet_aftersheetadd_event.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_label: afterSheetAdd -title: afterSheetAdd event -description: You can learn about the afterSheetAdd 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. ---- - -# afterSheetAdd - -:::caution -The **afterSheetAdd** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("afterAction", (actionName, config) => { - if (actionName === "addSheet") { - console.log(actionName, config); - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires after a new sheet is added - -### Usage - -~~~jsx -afterSheetAdd: (sheet: object) => void; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -- `sheet` - (required) an object with the name and id of a new sheet - -### Example - -~~~jsx {5-8} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "afterSheetAdd" event -spreadsheet.events.on("afterSheetAdd", function(sheet) { - console.log("A new sheet is added:", sheet.name); - console.log(sheet); -}); -~~~ - -**Changelog:** Added in v4.1 - -**Related articles:** [Event handling](handling_events.md) \ No newline at end of file diff --git a/docs/api/spreadsheet_aftersheetclear_event.md b/docs/api/spreadsheet_aftersheetclear_event.md deleted file mode 100644 index 82d12190..00000000 --- a/docs/api/spreadsheet_aftersheetclear_event.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_label: afterSheetClear -title: afterSheetClear event -description: You can learn about the afterSheetClear 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. ---- - -# afterSheetClear - -:::caution -The **afterSheetClear** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("afterAction", (actionName, config) => { - if (actionName === "clearSheet") { - console.log(actionName, config); - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires after a sheet of the spreadsheet is cleared - -### Usage - -~~~jsx -afterSheetClear: (sheet: object) => void; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -- `sheet` - (required) an object with the name and id of a sheet - -### Example - -~~~jsx {5-8} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "afterSheetClear" event -spreadsheet.events.on("afterSheetClear", function(sheet){ - console.log("The " + sheet.name + " is cleared"); - console.log(sheet); -}); -~~~ - -**Changelog:** Added in v4.2 - -**Related articles:** [Event handling](handling_events.md) \ No newline at end of file diff --git a/docs/api/spreadsheet_aftersheetremove_event.md b/docs/api/spreadsheet_aftersheetremove_event.md deleted file mode 100644 index 57b96a4b..00000000 --- a/docs/api/spreadsheet_aftersheetremove_event.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_label: afterSheetRemove -title: afterSheetRemove event -description: You can learn about the afterSheetRemove 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. ---- - -# afterSheetRemove - -:::caution -The **afterSheetRemove** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("afterAction", (actionName, config) => { - if (actionName === "deleteSheet") { - console.log(actionName, config); - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires after a sheet is removed - -### Usage - -~~~jsx -afterSheetRemove: (sheet: object) => void; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -- `sheet` - (required) an object with the name and id of a sheet - -### Example - -~~~jsx {5-8} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "afterSheetRemove" event -spreadsheet.events.on("afterSheetRemove", function(sheet) { - console.log("The " + sheet.name + "sheet is removed"); - console.log(sheet); -}); -~~~ - -**Changelog:** Added in v4.1 - -**Related articles:** [Event handling](handling_events.md) \ No newline at end of file diff --git a/docs/api/spreadsheet_aftersheetrename_event.md b/docs/api/spreadsheet_aftersheetrename_event.md deleted file mode 100644 index 7a07e028..00000000 --- a/docs/api/spreadsheet_aftersheetrename_event.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_label: afterSheetRename -title: afterSheetRename event -description: You can learn about the afterSheetRename 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. ---- - -# afterSheetRename - -:::caution -The **afterSheetRename** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("afterAction", (actionName, config) => { - if (actionName === "renameSheet") { - console.log(actionName, config); - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires after a sheet is renamed - -### Usage - -~~~jsx -afterSheetRename: (sheet: object) => void; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -- `sheet` - (required) an object with the name and id of a sheet - -### Example - -~~~jsx {5-8} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "afterSheetRename" event -spreadsheet.events.on("afterSheetRename", function(sheet) { - console.log("The sheet is renamed to", sheet.name ); - console.log(sheet); -}); -~~~ - -**Changelog:** Added in v4.1 - -**Related articles:** [Event handling](handling_events.md) \ No newline at end of file diff --git a/docs/api/spreadsheet_afterstylechange_event.md b/docs/api/spreadsheet_afterstylechange_event.md deleted file mode 100644 index 66b38bf4..00000000 --- a/docs/api/spreadsheet_afterstylechange_event.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -sidebar_label: afterStyleChange -title: afterStyleChange event -description: You can learn about the afterStyleChange 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. ---- - -# afterStyleChange - -:::caution -The **afterStyleChange** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("afterAction", (actionName, config) => { - if (actionName === "setCellStyle") { - console.log(actionName, config); - return false; - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires after the style of a cell is changed - -### Usage - -~~~jsx -afterStyleChange: (cell: string, style: object | array) => void; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -- `cell` - (required) the id of a cell -- `style` - (required) styles set for a cell - -### Example - -~~~jsx {5-8} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "afterStyleChange" event -spreadsheet.events.on("afterStyleChange", function(cell, style){ - console.log("Style of cell "+spreadsheet.selection.getSelectedCell()+" is changed"); - console.log(cell, style); -}); -~~~ - -**Related articles:** [Event handling](handling_events.md) \ No newline at end of file diff --git a/docs/api/spreadsheet_aftervaluechange_event.md b/docs/api/spreadsheet_aftervaluechange_event.md deleted file mode 100644 index ebada990..00000000 --- a/docs/api/spreadsheet_aftervaluechange_event.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -sidebar_label: afterValueChange -title: afterValueChange event -description: You can learn about the afterValueChange 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. ---- - -# afterValueChange - -:::caution -The **afterValueChange** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("afterAction", (actionName, config) => { - if (actionName === "setCellValue") { - console.log(actionName, config); - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires after the value of a cell changes - -### Usage - -~~~jsx -afterValueChange: (cell: string, value: string) => void; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -- `cell` - (required) the id of a cell -- `value` - (required) the value of a cell - -### Example - -~~~jsx {5-8} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "afterValueChange" event -spreadsheet.events.on("afterValueChange", function(cell, value){ - console.log("Value of cell "+ spreadsheet.selection.getSelectedCell()+" has changed"); - console.log(cell, value); -}); -~~~ - -**Related articles:** [Event handling](handling_events.md) diff --git a/docs/api/spreadsheet_beforecolumnadd_event.md b/docs/api/spreadsheet_beforecolumnadd_event.md deleted file mode 100644 index 64a6a83d..00000000 --- a/docs/api/spreadsheet_beforecolumnadd_event.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -sidebar_label: beforeColumnAdd -title: beforeColumnAdd event -description: You can learn about the beforeColumnAdd 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. ---- - -# beforeColumnAdd - -:::caution -The **beforeColumnAdd** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("beforeAction", (actionName, config) => { - if (actionName === "addColumn") { - console.log(actionName, config); - return false; - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires before a new column is added - -### Usage - -~~~jsx -beforeColumnAdd: (cell: string) => void | boolean; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -`cell` - (required) the id of a cell - -### Returns - -Return `true` to add a column, `false` to prevent adding of a column - -### Example - -~~~jsx {5-9} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "beforeColumnAdd" event -spreadsheet.events.on("beforeColumnAdd", function(cell){ - console.log("A new column will be added"); - console.log(cell); - return true; -}); -~~~ - -**Related articles:** [Event handling](handling_events.md) \ No newline at end of file diff --git a/docs/api/spreadsheet_beforecolumndelete_event.md b/docs/api/spreadsheet_beforecolumndelete_event.md deleted file mode 100644 index 6022d69f..00000000 --- a/docs/api/spreadsheet_beforecolumndelete_event.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -sidebar_label: beforeColumnDelete -title: beforeColumnDelete event -description: You can learn about the beforeColumnDelete 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. ---- - -# beforeColumnDelete - -:::caution -The **beforeColumnDelete** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("beforeAction", (actionName, config) => { - if (actionName === "deleteColumn") { - console.log(actionName, config); - return false; - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires before a column is deleted - -### Usage - -~~~jsx -beforeColumnDelete: (cell: string) => void | boolean; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -- `cell` - (required) the id of a cell - -### Returns - -Return `true` to delete a column, `false` to prevent deleting of a column - -### Example - -~~~jsx {5-9} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "beforeColumnDelete" event -spreadsheet.events.on("beforeColumnDelete", function(cell){ - console.log("A column will be deleted"); - console.log(cell); - return true; -}); -~~~ - -**Related articles:** [Event handling](handling_events.md) \ No newline at end of file diff --git a/docs/api/spreadsheet_beforeformatchange_event.md b/docs/api/spreadsheet_beforeformatchange_event.md deleted file mode 100644 index 16849716..00000000 --- a/docs/api/spreadsheet_beforeformatchange_event.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -sidebar_label: beforeFormatChange -title: beforeFormatChange event -description: You can learn about the beforeFormatChange 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. ---- - -# beforeFormatChange - -:::caution -The **beforeFormatChange** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("beforeAction", (actionName, config) => { - if (actionName === "setCellFormat") { - console.log(actionName, config); - return false; - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires before the format of a cell is changed - -### Usage - -~~~jsx -beforeFormatChange: (cell: string, format: string) => void | boolean; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -- `cell` - (required) the id of a cell -- `format` - (required) a new format applied for a cell - -### Returns - -Return `true` to change the format, `false` to prevent changing of the format - -### Example - -~~~jsx {5-8} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "beforeFormatChange" event -spreadsheet.events.on("beforeFormatChange", function(cell, format){ - console.log("Format of cell "+spreadsheet.selection.getSelectedCell()+" will change"); - console.log(cell, format); -}); -~~~ - -**Related articles:** -- [Number formatting](number_formatting.md) -- [Event handling](handling_events.md) - -**Related sample**: [Spreadsheet. Events](https://snippet.dhtmlx.com/2vkjyvsi) - - diff --git a/docs/api/spreadsheet_beforerowadd_event.md b/docs/api/spreadsheet_beforerowadd_event.md deleted file mode 100644 index be9faff8..00000000 --- a/docs/api/spreadsheet_beforerowadd_event.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -sidebar_label: beforeRowAdd -title: beforeRowAdd event -description: You can learn about the beforeRowAdd 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. ---- - -# beforeRowAdd - -:::caution -The **beforeRowAdd** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("beforeAction", (actionName, config) => { - if (actionName === "addRow") { - console.log(actionName, config); - return false; - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires before a new row is added - -### Usage - -~~~jsx -beforeRowAdd: (cell: string) => void | boolean; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -- `cell` - (required) the id of a cell - -### Returns - -Return `true` to add a row, `false` to prevent adding of a row - -### Example - -~~~jsx {5-9} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "beforeRowAdd" event -spreadsheet.events.on("beforeRowAdd", function(cell){ - console.log("A new row will be added"); - console.log(cell); - return true; -}); -~~~ - -**Related articles:** [Event handling](handling_events.md) \ No newline at end of file diff --git a/docs/api/spreadsheet_beforerowdelete_event.md b/docs/api/spreadsheet_beforerowdelete_event.md deleted file mode 100644 index 3745edc4..00000000 --- a/docs/api/spreadsheet_beforerowdelete_event.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -sidebar_label: beforeRowDelete -title: beforeRowDelete event -description: You can learn about the beforeRowDelete 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. ---- - -# beforeRowDelete - -:::caution -The **beforeRowDelete** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("beforeAction", (actionName, config) => { - if (actionName === "deleteRow") { - console.log(actionName, config); - return false; - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires before a row is deleted - -### Usage - -~~~jsx -beforeRowDelete: (cell: string) => void | boolean; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -- `cell` - (required) the id of a cell - -### Returns - -Return `true` to delete a row, `false` to prevent deleting of a row - -### Example - -~~~jsx {5-9} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "beforeRowDelete" event -spreadsheet.events.on("beforeRowDelete", function(cell){ - console.log("A row will be deleted"); - console.log(cell); - return true; -}); -~~~ - -**Related articles:** [Event handling](handling_events.md) \ No newline at end of file diff --git a/docs/api/spreadsheet_beforesheetadd_event.md b/docs/api/spreadsheet_beforesheetadd_event.md deleted file mode 100644 index 5a88b532..00000000 --- a/docs/api/spreadsheet_beforesheetadd_event.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_label: beforeSheetAdd -title: beforeSheetAdd event -description: You can learn about the beforeSheetAdd 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. ---- - -# beforeSheetAdd - -:::caution -The **beforeSheetAdd** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("beforeAction", (actionName, config) => { - if (actionName === "addSheet") { - console.log(actionName, config); - return false; - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires before a new sheet is added - -### Usage - -~~~jsx -beforeSheetAdd: (name: string) => void | boolean; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -- `name` - (required) the name of the new sheet - -### Returns - -Return `true` to add a sheet, `false` to prevent adding of a sheet - -### Example - -~~~jsx {5-9} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "beforeSheetAdd" event -spreadsheet.events.on("beforeSheetAdd", function(name) { - console.log("A new sheet will be added"); - console.log(name); - return true; -}); -~~~ - -**Changelog:** Added in v4.1 - -**Related articles:** [Event handling](handling_events.md) \ No newline at end of file diff --git a/docs/api/spreadsheet_beforesheetclear_event.md b/docs/api/spreadsheet_beforesheetclear_event.md deleted file mode 100644 index ad3315c7..00000000 --- a/docs/api/spreadsheet_beforesheetclear_event.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_label: beforeSheetClear -title: beforeSheetClear event -description: You can learn about the beforeSheetClear 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. ---- - -# beforeSheetClear - -:::caution -The **beforeSheetClear** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("beforeAction", (actionName, config) => { - if (actionName === "clearSheet") { - console.log(actionName, config); - return false; - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires before a sheet of the spreadsheet is cleared - -### Usage - -~~~jsx -beforeSheetClear: (sheet: object) => void | boolean; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -- `sheet` - (required) an object with the name and id of a sheet - -### Returns - -Return `true` to clear the active sheet, `false` to prevent the active sheet from being cleared - -### Example - -~~~jsx {5-9} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "beforeSheetClear" event -spreadsheet.events.on("beforeSheetClear", function(sheet){ - console.log("The " + sheet.name + " sheet will be cleared"); - console.log(sheet); - return true; -}); -~~~ - -**Changelog:** Added in v4.2 - -**Related articles:** [Event handling](handling_events.md) \ No newline at end of file diff --git a/docs/api/spreadsheet_beforesheetremove_event.md b/docs/api/spreadsheet_beforesheetremove_event.md deleted file mode 100644 index cd8b3a51..00000000 --- a/docs/api/spreadsheet_beforesheetremove_event.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_label: beforeSheetRemove -title: beforeSheetRemove event -description: You can learn about the beforeSheetRemove 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. ---- - -# beforeSheetRemove - -:::caution -The **beforeSheetRemove** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("beforeAction", (actionName, config) => { - if (actionName === "deleteSheet") { - console.log(actionName, config); - return false; - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires before a sheet is removed - -### Usage - -~~~jsx -beforeSheetRemove: (sheet: object) => void | boolean; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -- `sheet` - (required) an object with the name and id of a sheet - -### Returns - -Return `true` to remove the active sheet, `false` to prevent the active sheet from being removed - -### Example - -~~~jsx {5-9} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "beforeSheetRemove" event -spreadsheet.events.on("beforeSheetRemove", function(sheet) { - console.log("The ", sheet.name, " sheet will be removed"); - console.log(sheet); - return true; -}); -~~~ - -**Changelog:** Added in v4.1 - -**Related articles:** [Event handling](handling_events.md) \ No newline at end of file diff --git a/docs/api/spreadsheet_beforesheetrename_event.md b/docs/api/spreadsheet_beforesheetrename_event.md deleted file mode 100644 index 72ef1973..00000000 --- a/docs/api/spreadsheet_beforesheetrename_event.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -sidebar_label: beforeSheetRename -title: beforeSheetRename event -description: You can learn about the beforeSheetRename 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. ---- - -# beforeSheetRename - -:::caution -The **beforeSheetRename** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("beforeAction", (actionName, config) => { - if (actionName === "renameSheet") { - console.log(actionName, config); - return false; - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires before a sheet is renamed - -### Usage - -~~~jsx -beforeSheetRename: (sheet: object, value: string) => void | boolean; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -- `sheet` - (required) an object with the old name of a sheet and its id -- `value` - (required) the new name of the sheet - -### Returns - -Return `true` to rename a sheet, `false` to prevent the sheet from being renamed - -### Example - -~~~jsx {5-9} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "beforeSheetRename" event -spreadsheet.events.on("beforeSheetRename", function(sheet, value) { - console.log("The ", sheet.name, "sheet will be renamed to ", value); - console.log(sheet, value); - return true; -}); -~~~ - -**Changelog:** Added in v4.1 - -**Related articles:** [Event handling](handling_events.md) \ No newline at end of file diff --git a/docs/api/spreadsheet_beforestylechange_event.md b/docs/api/spreadsheet_beforestylechange_event.md deleted file mode 100644 index 76798c08..00000000 --- a/docs/api/spreadsheet_beforestylechange_event.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -sidebar_label: beforeStyleChange -title: beforeStyleChange event -description: You can learn about the beforeStyleChange 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. ---- - -# beforeStyleChange - -:::caution -The **beforeStyleChange** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("beforeAction", (actionName, config) => { - if (actionName === "setCellStyle") { - console.log(actionName, config); - return false; - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires before the style of cells is changed - -### Usage - -~~~jsx -beforeStyleChange: ( - cell: string, - style: string | object | array -) => void | boolean; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -- `cell` - (required) the id(s) of a cell(s) -- `style` - (required) styles set for a cell/cells - -### Returns - -Return `true` to change the style of a cell, `false` to prevent changing of style - -### Example - -~~~jsx {5-9} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "beforeStyleChange" event -spreadsheet.events.on("beforeStyleChange", function(cell, style){ - console.log("Style of cell "+spreadsheet.selection.getSelectedCell()+" will change"); - console.log(cell, style); - return true; -}); -~~~ - -**Related articles:** [Event handling](handling_events.md) \ No newline at end of file diff --git a/docs/api/spreadsheet_beforevaluechange_event.md b/docs/api/spreadsheet_beforevaluechange_event.md deleted file mode 100644 index f3d63ee6..00000000 --- a/docs/api/spreadsheet_beforevaluechange_event.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -sidebar_label: beforeValueChange -title: beforeValueChange event -description: You can learn about the beforeValueChange 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. ---- - -# beforeValueChange - -:::caution -The **beforeValueChange** event has been deprecated in v4.3. The event will continue work, but you'd better apply a new approach: - -~~~jsx -spreadsheet.events.on("beforeAction", (actionName, config) => { - if (actionName === "setCellValue") { - console.log(actionName, config); - return false; - } -}); -~~~ - -For more details about the new concept, see **[Spreadsheet actions](api/overview/actions_overview.md)**. -::: - -### Description - -@short: Fires before the values of cells are changed - -### Usage - -~~~jsx -beforeValueChange: (cell: string, value: string) => void | boolean; -~~~ - -### Parameters - -The callback of the event takes the following parameters: - -- `cell` - (required) the id of a cell -- `value` - (required) the value of a cell - -### Returns - -Return `true` to change the value of a cell, `false` to prevent changing of value - -### Example - -~~~jsx {5-9} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// subscribe on the "beforeValueChange" event -spreadsheet.events.on("beforeValueChange", function(cell, value){ - console.log("Value of cell "+ spreadsheet.selection.getSelectedCell()+" will change"); - console.log(cell, value); - return true; -}); -~~~ - -**Related articles:** [Event handling](handling_events.md) \ No newline at end of file diff --git a/docs/api/spreadsheet_clearsheet_method.md b/docs/api/spreadsheet_clearsheet_method.md deleted file mode 100644 index 32fb4aa6..00000000 --- a/docs/api/spreadsheet_clearsheet_method.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -sidebar_label: clearSheet() -title: clearSheet method -description: You can learn about the clearSheet 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. ---- - -# clearSheet() - -### Description - -@short: Clears a sheet - -### Usage - -~~~jsx -clearSheet(id?: string): void; -~~~ - -### Parameters - -- `id` - (optional) the id of a sheet to be cleared. If not specified, the method clears the currently active sheet - -### Example - -~~~jsx {5,7} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// clears the sheet by its id -spreadsheet.clearSheet("u1636003130922"); -// clears the currently active sheet -spreadsheet.clearSheet(); -~~~ - -**Changelog:** Added in v4.2 - -**Related articles:** [Clearing sheets](working_with_sheets.md/#clearing-sheets) - -**Related sample:** [Spreadsheet. Clear](https://snippet.dhtmlx.com/szmtjn72) - diff --git a/docs/api/spreadsheet_dateformat_config.md b/docs/api/spreadsheet_dateformat_config.md deleted file mode 100644 index e176f8e9..00000000 --- a/docs/api/spreadsheet_dateformat_config.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -sidebar_label: dateFormat -title: dateFormat config -description: You can learn about the dateFormat config 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. ---- - -# dateFormat - -### Description - -@short: Optional. Defines the format of dates in the spreadsheet - -### Usage - -~~~jsx -dateFormat?: string; -~~~ - -### Default config - -~~~jsx -dateFormat: "%d/%m/%Y" -~~~ - -### Example - -~~~jsx {2} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", { - dateFormat: "%D/%M/%Y", - // other config parameters -}); - -spreadsheet.parse({ - styles: { - // a set of styles - }, - data: [ - {cell: "B1", value: "03/10/2022", format: "date"}, - {cell: "B2", value: new Date(), format: "date"}, - ] -}); -~~~ - -### List of characters - -DHTMLX Spreadsheet uses the following characters for setting a date format: - -| Character | Definition | -|-----------|---------------------------------------------------| -| **%d** | day as a number with leading zero, 01..31 | -| **%j** | day as a number, 1..31 | -| **%D** | short name of the day, Su Mo Tu... | -| **%l** | full name of the day, Sunday Monday Tuesday... | -| **%m** | month as a number with leading zero, 01..12 | -| **%n** | month as a number, 1..12 | -| **%M** | short name of the month, Jan Feb Mar... | -| **%F** | full name of the month, January February March... | -| **%y** | year as a number, 2 digits | -| **%Y** | year as a number, 4 digits | -| **%h** | hours 12-format with leading zero, 01..12) | -| **%g** | hours 12-format, 1..12) | -| **%H** | hours 24-format with leading zero, 00..23 | -| **%G** | hours 24-format, 0..23 | -| **%i** | minutes with leading zero, 01..59 | -| **%s** | seconds with leading zero, 01..59 | -| **%a** | am or pm | -| **%A** | AM or PM | -| **%u** | milliseconds | - -**Change log:** -- From v4.3, it is possible to set the date as a *new Date()* object in the data set -- Added in v4.2 - -**Related articles:** [Date format](number_formatting.md/#date-format) \ No newline at end of file diff --git a/docs/api/spreadsheet_getactivesheet_method.md b/docs/api/spreadsheet_getactivesheet_method.md deleted file mode 100644 index 0178982d..00000000 --- a/docs/api/spreadsheet_getactivesheet_method.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -sidebar_label: getActiveSheet() -title: getactiveSheet method -description: You can learn about the getactiveSheet 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. ---- - -# getActiveSheet() - -### Description - -@short: Returns the sheet that is currently active - -### Usage - -~~~jsx -getActiveSheet(): object; -~~~ - -### Returns - -The method returns an object with the name and id attributes of the active sheet - -### Example - -~~~jsx {5} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// returns {name: "sheet", id: "u1614675531904"} -spreadsheet.getActiveSheet(); -~~~ - -**Change log:** Added in v4.1 diff --git a/docs/api/spreadsheet_getsheets_method.md b/docs/api/spreadsheet_getsheets_method.md deleted file mode 100644 index 13031939..00000000 --- a/docs/api/spreadsheet_getsheets_method.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -sidebar_label: getSheets() -title: getSheets method -description: You can learn about the getSheets 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. ---- - -# getSheets() - -### Description - -@short: Gets all sheets of the spreadsheet - -### Usage - -~~~jsx -getSheets(): array; -~~~ - -### Returns - -The method returns an array of sheets objects - -:::info -Each sheet object includes the **name** and **id** attributes of the sheet. -::: - -### Example - -~~~jsx {5} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// returns [{name: "sheet1", id: "u1614669331194"}, …] -spreadsheet.getSheets(); -~~~ - -**Change log:** Added in v4.1 diff --git a/docs/api/spreadsheet_localization_config.md b/docs/api/spreadsheet_localization_config.md index 1ad1c9ac..40d79fb0 100644 --- a/docs/api/spreadsheet_localization_config.md +++ b/docs/api/spreadsheet_localization_config.md @@ -23,7 +23,7 @@ The **localization** object may contain the following properties: - **decimal** - (optional) the symbol used as a decimal separator, **"."** by default.
Possible values are `"." | ","` - **thousands** - (optional) the symbol used as a thousands separator, **","** by default.
Possible values are `"." | "," | " " | ""` - **currency** - (optional) the currency sign, **"$"** by default -- **dateFormat** - (optional) the format of displaying dates set as a string. The default format is **"%d/%m/%Y"**. Check the details at the [dateFormat](api/spreadsheet_dateformat_config.md) API page +- **dateFormat** - (optional) the format of displaying dates set as a string. The default format is **"%d/%m/%Y"**. Check details [below](#characters-for-setting-date-format) - **timeFormat** - (optional) the format of displaying time set as either *12* or *24*. The default format is **12** ### Default config @@ -54,6 +54,32 @@ const spreadsheet = new dhx.Spreadsheet("spreadsheet", { spreadsheet.parse(dataset); ~~~ +### Characters for setting date format + +DHTMLX Spreadsheet uses the following characters for setting a date format: + +| Character | Definition | +|-----------|---------------------------------------------------| +| **%d** | day as a number with leading zero, 01..31 | +| **%j** | day as a number, 1..31 | +| **%D** | short name of the day, Su Mo Tu... | +| **%l** | full name of the day, Sunday Monday Tuesday... | +| **%m** | month as a number with leading zero, 01..12 | +| **%n** | month as a number, 1..12 | +| **%M** | short name of the month, Jan Feb Mar... | +| **%F** | full name of the month, January February March... | +| **%y** | year as a number, 2 digits | +| **%Y** | year as a number, 4 digits | +| **%h** | hours 12-format with leading zero, 01..12) | +| **%g** | hours 12-format, 1..12) | +| **%H** | hours 24-format with leading zero, 00..23 | +| **%G** | hours 24-format, 0..23 | +| **%i** | minutes with leading zero, 01..59 | +| **%s** | seconds with leading zero, 01..59 | +| **%a** | am or pm | +| **%A** | AM or PM | +| **%u** | milliseconds | + **Change log:** - Added in v5.1 diff --git a/docs/api/spreadsheet_removesheet_method.md b/docs/api/spreadsheet_removesheet_method.md deleted file mode 100644 index 61b0c9fc..00000000 --- a/docs/api/spreadsheet_removesheet_method.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebar_label: removeSheet() -title: removeSheet method -description: You can learn about the removeSheet 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. ---- - -# removeSheet() - -### Description - -@short: Removes a sheet from the spreadsheet by its id - -:::info -To apply this method, you need to enable the [multiSheets](api/spreadsheet_multisheets_config.md) configuration option. - -Also note, that a sheet won't be deleted if the number of sheets in the spreadsheet is less than 2. -::: - -### Usage - -~~~jsx -removeSheet(id: string): void; -~~~ - -### Parameters - -- `id` - (required) the id of a sheet - -### Example - -~~~jsx {5} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// removes a sheet from the spreadsheet by the specified id -spreadsheet.removeSheet("u1614669331209"); -~~~ - -**Change log:** Added in v4.1 diff --git a/docs/api/spreadsheet_setactivesheet_method.md b/docs/api/spreadsheet_setactivesheet_method.md deleted file mode 100644 index f564062a..00000000 --- a/docs/api/spreadsheet_setactivesheet_method.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -sidebar_label: setActiveSheet() -title: setActiveSheet method -description: You can learn about the setActiveSheet 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. ---- - -# setActiveSheet() - -### Description - -@short: Sets the active sheet by its id - -### Usage - -~~~jsx -setActiveSheet(id: string): void; -~~~ - -### Parameters - -- `id` - (required) the id of a sheet - -### Example - -~~~jsx {5} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", {}); -spreadsheet.parse(data); - -// sets the active sheet by the specified id -spreadsheet.setActiveSheet("u1636003130922"); -~~~ - -**Change log:** Added in v4.2 - -**Related articles:** [Setting active sheet](working_with_sheets.md/#setting-active-sheet) - -**Related sample:** [Spreadsheet. Set active sheet](https://snippet.dhtmlx.com/iowl449t) diff --git a/docs/api/spreadsheet_timeformat_config.md b/docs/api/spreadsheet_timeformat_config.md deleted file mode 100644 index cdfd295a..00000000 --- a/docs/api/spreadsheet_timeformat_config.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_label: timeFormat -title: timeFormat config -description: You can learn about the dateFormat config 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. ---- - -# timeFormat - -### Description - -@short: Optional. Defines the format of time in the spreadsheet - -### Usage - -~~~jsx -timeFormat?: number; // 12 | 24 -~~~ - -### Default config - -~~~jsx -timeFormat: 12 -~~~ - -### Example - -~~~jsx {2} -const spreadsheet = new dhx.Spreadsheet("spreadsheet", { - timeFormat: 24, - // other config parameters -}); - -spreadsheet.parse({ - styles: { - // a set of styles - }, - data: [ - { cell: "A1", value: "18:30", format: "time" }, - { cell: "A2", value: 44550.5625, format: "time" }, - { cell: "A3", value: new Date(), format: "time" }, - ] -}); -~~~ - -**Change log:** Added in v4.3 - -**Related articles:** [Time format](number_formatting.md/#time-format) \ No newline at end of file diff --git a/docs/assets/jsdoc_hints.png b/docs/assets/jsdoc_hints.png new file mode 100644 index 00000000..32f3f96b Binary files /dev/null and b/docs/assets/jsdoc_hints.png differ diff --git a/docs/customization.md b/docs/customization.md index 8caed98f..4f2d5cb7 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -413,22 +413,19 @@ spreadsheet.contextMenu.data.remove("lock"); Besides applying the [read-only mode](configuration.md#read-only-mode) to the whole Spreadsheet, you can block certain operations via the events the name of which starts with **before**, e.g.: - [](api/spreadsheet_beforeeditstart_event.md) -- [](api/spreadsheet_beforestylechange_event.md) -- [](api/spreadsheet_beforevaluechange_event.md) +- [](api/spreadsheet_beforeaction_event.md) ~~~jsx -var spreadsheet = new dhx.Spreadsheet("cont"); +const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", {}); spreadsheet.events.on("beforeEditStart", function(){ return false; }); -spreadsheet.events.on("beforeValueChange", function(){ - return false; -}); - -spreadsheet.events.on("beforeStyleChange", function(){ - return false; +spreadsheet.events.on("beforeAction", function(actionName){ + if (actionName === "setCellValue" || actionName === "setCellStyle") { + return false; + } }); spreadsheet.parse(data); diff --git a/docs/migration.md b/docs/migration.md index 95221eb1..08a2172e 100644 --- a/docs/migration.md +++ b/docs/migration.md @@ -6,13 +6,76 @@ description: You can learn about migration in the documentation of the DHTMLX Ja # Migration to newer versions +## 5.2 -> 6.0 + +### Deprecated properties + +The following properties of `ISpreadsheetConfig` are deprecated and removed. Check the current usage below: + +- `dateFormat` configuration property. Set it in the [**localization**](api/spreadsheet_localization_config.md) configuration object as: + - `{ localization: { dateFormat: "%d/%m/%Y" } }` +- `timeFormat` configuration property. Set it in the [**localization**](api/spreadsheet_localization_config.md) configuration object as: + - `{ localization: { timeFormat: 12 } }` + +### Deprecated methods + +The following methods of the `ISpreadsheet` instance are deprecated and removed. + +Use the new [`sheets` module (Sheet Manager) API](/api/overview/sheetmanager_overview/) instead: + +
+ +| Deprecated method | Signature | New usage | New signature | +| --- | --- | --- | --- | +| `clearSheet(id?)` | `(id?: string) => void` | [`sheets.clear(id?)`](api/sheetmanager_clear_method.md) | `(id?: Id) => void` | +| `removeSheet(id)` | `(id: string) => void` | [`sheets.remove(id)`](api/sheetmanager_remove_method.md) | `(id: Id) => void` | +| `addSheet(name?)` | `(name?: string) => string` | [`sheets.add(name?)`](api/sheetmanager_add_method.md) | `(name?: string) => Id` | +| `getSheets()` | `() => ISheet[]` | [`sheets.getAll()`](api/sheetmanager_getall_method.md) | `() => ISheet[]` | +| `getActiveSheet()` | `() => ISheet` | [`sheets.getActive()`](api/sheetmanager_getactive_method.md) | `() => ISheet` | +| `setActiveSheet(id)` | `(id: Id) => void` | [`sheets.setActive(id)`](api/sheetmanager_setactive_method.md) | `(id: Id) => void` | + +
+ +### Deprecated events + +The following events are deprecated and removed. Use the generic [`beforeAction`](api/spreadsheet_beforeaction_event.md) / [`afterAction`](api/spreadsheet_afteraction_event.md) events pair instead. + +
+ +| Deprecated event | Callback signature | New usage | +| --- | --- | --- | +| `beforeValueChange` | `(cell: string, value: string) => void \| boolean` | `beforeAction` with action `"setCellValue"` | +| `afterValueChange` | `(cell: string, value: string) => void` | `afterAction` with action `"setCellValue"` | +| `beforeStyleChange` | `(cell: string, style: ...) => void \| boolean` | `beforeAction` with action `"setCellStyle"` | +| `afterStyleChange` | `(cell: string, style: ...) => void` | `afterAction` with action `"setCellStyle"` | +| `beforeFormatChange` | `(cell: string, format: string) => void \| boolean` | `beforeAction` with action `"setCellFormat"` | +| `afterFormatChange` | `(cell: string, format: string) => void` | `afterAction` with action `"setCellFormat"` | +| `beforeRowAdd` | `(cell: string) => void \| boolean` | `beforeAction` with action `"addRow"` | +| `afterRowAdd` | `(cell: string) => void` | `afterAction` with action `"addRow"` | +| `beforeRowDelete` | `(cell: string) => void \| boolean` | `beforeAction` with action `"deleteRow"` | +| `afterRowDelete` | `(cell: string) => void` | `afterAction` with action `"deleteRow"` | +| `beforeColumnAdd` | `(cell: string) => void \| boolean` | `beforeAction` with action `"addColumn"` | +| `afterColumnAdd` | `(cell: string) => void` | `afterAction` with action `"addColumn"` | +| `beforeColumnDelete` | `(cell: string) => void \| boolean` | `beforeAction` with action `"deleteColumn"` | +| `afterColumnDelete` | `(cell: string) => void` | `afterAction` with action `"deleteColumn"` | +| `beforeSheetAdd` | `(name: string) => void \| boolean` | `beforeAction` with action `"addSheet"` | +| `afterSheetAdd` | `(sheet: ISheet) => void` | `afterAction` with action `"addSheet"` | +| `beforeSheetRemove` | `(sheet: ISheet) => void \| boolean` | `beforeAction` with action `"deleteSheet"` | +| `afterSheetRemove` | `(sheet: ISheet) => void` | `afterAction` with action `"deleteSheet"` | +| `beforeSheetRename` | `(sheet: ISheet, value: string) => void \| boolean` | `beforeAction` with action `"renameSheet"` | +| `afterSheetRename` | `(sheet: ISheet) => void` | `afterAction` with action `"renameSheet"` | +| `beforeSheetClear` | `(sheet: ISheet) => void \| boolean` | `beforeAction` with action `"clearSheet"` | +| `afterSheetClear` | `() => void` | `afterAction` with action `"clearSheet"` | + +
+ ## 5.1 -> 5.2 ### Freezing/unfreezing functionality In v5.2 the way of freezing/unfreezing columns and rows has been modified: -- the `leftSplit` and `topSplit` configuration properties that have been used for fixing columns and rows are deprecated +- the `leftSplit` and `topSplit` configuration properties that have been used for fixing columns and rows are deprecated and removed ~~~jsx title="Before v5.2" const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", { diff --git a/docs/number_formatting.md b/docs/number_formatting.md index acccef4e..9a420a70 100644 --- a/docs/number_formatting.md +++ b/docs/number_formatting.md @@ -10,13 +10,15 @@ DHTMLX Spreadsheet supports number formatting that you can apply for numeric val ![Number format](assets/number_format_options.png) -{{note There is a [User Guide](number_formatting_guide.md) provided to make work with Spreadsheet easy for your end users.}} +:::note +There is a [User Guide](number_formatting_guide.md) provided to make work with Spreadsheet easy for your end users. +::: ## Default number formats A number format is an object that includes a set of properties: -- **id** - the id of a format that is used to set format to a cell via the [](api/spreadsheet_setformat_method.md) method +- **id** - the id of a format that is used to set format to a cell via the [`setFormat()`](api/spreadsheet_setformat_method.md) method - **mask** - a mask for a number format. Check the list of characters available in a mask [below](#the-structure-of-a-mask) - **name** - the name of a format displayed in the toolbar and menu drop-down lists - **example** - an example that shows how a formatted number looks like. The number 2702.31 is used as a default value for format examples @@ -33,7 +35,7 @@ defaultFormats = [ { name: "Time", id: "time", - mask: hh:mm:ss am/pm || hh:mm:ss, // depending on the timeFormat config + mask: hh:mm:ss am/pm || hh:mm:ss, // depending on the localization.timeFormat config example: "13:30:00" }, { name: "Text", id: "text", mask: "@", example: "'1500.31'" } @@ -46,11 +48,13 @@ This is how a spreadsheet with data in various number formats looks like: ## Date format -You can define the format the dates to be displayed in the spreadsheet via the [dateFormat](api/spreadsheet_dateformat_config.md) property. The default format is "%d/%m/%Y". +You can define the format for dates displayed in the spreadsheet via the `dateFormat` option of the [`localization`](api/spreadsheet_localization_config.md) property. The default format is "%d/%m/%Y". ~~~jsx -const spreadsheet = new dhx.Spreadsheet("spreadsheet", { - dateFormat: "%D/%M/%Y", +const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", { + localization: { + dateFormat: "%D/%M/%Y", + } }); spreadsheet.parse({ @@ -60,19 +64,21 @@ spreadsheet.parse({ data: [ {cell: "B1", value: "03/10/2022", format: "date"}, {cell: "B2", value: new Date(), format: "date"}, - ] + ] }); ~~~ -Check [the full list of available characters used to make formats](api/spreadsheet_dateformat_config.md). +Check [the full list of available characters used to make formats](/api/spreadsheet_localization_config/#characters-for-setting-date-format). ## Time format -To define the format in which the time should be shown in the spreadsheet cells, use the [timeFormat](api/spreadsheet_timeformat_config.md) property: +To define the format in which the time should be shown in the spreadsheet cells, use the `timeFormat` option of the [`localization`](api/spreadsheet_localization_config.md) property: ~~~jsx -const spreadsheet = new dhx.Spreadsheet("spreadsheet", { - timeFormat: 24, +const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", { + localization: { + timeFormat: 24, + } }); spreadsheet.parse({ @@ -83,18 +89,18 @@ spreadsheet.parse({ { cell: "A1", value: "18:30", format: "time" }, { cell: "A2", value: 44550.5625, format: "time" }, { cell: "A3", value: new Date(), format: "time" }, - ] + ] }); ~~~ ## Number, date, time, currency localization -With Spreadsheet configuration options, you can localize time and date, specify the necessary currency sign and provide the desired decimal and thousands separators. All these settings are available in the [localization](spreadsheet/api/spreadsheet_localization_config.md) property. It is an object with the following properties: +With Spreadsheet configuration options, you can localize time and date, specify the necessary currency sign and provide the desired decimal and thousands separators. All these settings are available in the [`localization`](spreadsheet/api/spreadsheet_localization_config.md) property. It is an object with the following properties: - **decimal** - (optional) the symbol used as a decimal separator, **"."** (a period) by default
Possible values are `"." | ","` - **thousands** - (optional) the symbol used as a thousands separator, **","** (a comma) by default
Possible values are `"." | "," | " " | ""` - **currency** - (optional) the currency sign, **"$"** by default -- **dateFormat** - (optional) the format of displaying dates set as a string, **"%d/%m/%Y"** by default. Check the details at the [dateFormat](api/spreadsheet_dateformat_config.md) API page +- **dateFormat** - (optional) the format of displaying dates set as a string, **"%d/%m/%Y"** by default. Check the details at the [`localization`](api/spreadsheet_localization_config.md) API page - **timeFormat** - (optional) the format of displaying time set as either *12* or *24*, **12** by default For example, you can change the default localization settings as shown below: @@ -126,9 +132,9 @@ You are not limited by [default number formats](#default-number-formats) only. T -All such modifications can be implemented via the [](api/spreadsheet_formats_config.md) configuration option. It represents an array of format objects each of which contains a set of properties: +All such modifications can be implemented via the [`formats`](api/spreadsheet_formats_config.md) configuration option. It represents an array of format objects each of which contains a set of properties: -- **id** - (*string*) mandatory, the id of a format that is used to set format to a cell via the [](api/spreadsheet_setformat_method.md) method +- **id** - (*string*) mandatory, the id of a format that is used to set format to a cell via the [`setFormat()`](api/spreadsheet_setformat_method.md) method - **mask** - (*string*) mandatory, a mask for a number format. Check the list of characters available in a mask [below](#the-structure-of-a-mask) - **name** - (*string*) optional, the name of a format that will be displayed in the toolbar and menu drop-down lists - **example** - (*string*) optional, an example that shows how a formatted number will look like @@ -147,7 +153,7 @@ A mask may contain a set of common syntax characters that include digit placehol ## Setting format -In order to apply the necessary format to a numeric value, make use of the [](api/spreadsheet_setformat_method.md) method. It takes two parameters: +In order to apply the necessary format to a numeric value, make use of the [`setFormat()`](api/spreadsheet_setformat_method.md) method. It takes two parameters: - **cell** - (*string*) the id of a cell the value of which should be formatted - **format** - (*string*) the name of the [default number format](#default-number-formats) to apply to the cell value @@ -161,7 +167,7 @@ spreadsheet.setFormat("A1","percent"); ## Getting format -You can get the number format applied to the value of a cell with the help of the [](api/spreadsheet_getformat_method.md) method. The method takes the id of a cell as a parameter. +You can get the number format applied to the value of a cell with the help of the [`getFormat()`](api/spreadsheet_getformat_method.md) method. The method takes the id of a cell as a parameter. ~~~jsx var format = spreadsheet.getFormat("A1"); @@ -172,5 +178,5 @@ var format = spreadsheet.getFormat("A1"); There is a pair of events you can use to control the process of cell's format changing. They are: -- [](api/spreadsheet_beforeformatchange_event.md) - fires before the format of a cell is changed -- [](api/spreadsheet_afterformatchange_event.md) - fires after the format of a cell is changed \ No newline at end of file +- [`beforeAction`](api/spreadsheet_beforeaction_event.md) - fires before the `setCellFormat` action is executed +- [`afterAction`](api/spreadsheet_afteraction_event.md) - fires after the `setCellFormat` action is executed \ No newline at end of file diff --git a/docs/using_typescript.md b/docs/using_typescript.md index 90daeebf..5704dc27 100644 --- a/docs/using_typescript.md +++ b/docs/using_typescript.md @@ -19,3 +19,9 @@ Why do you need to use DHTMLX Spreadsheet with TypeScript? The main benefit of TypeScript is that it allows you to significantly increase the efficiency of the development process. The way of building an application becomes more robust as checking the types together with autocompletion allow you to avoid potential mistakes. Besides, TypeScript provides you with information about types of data you should use while working with the API of the DHTMLX Spreadsheet library. + +## JSDoc hints + +DHTMLX Spreadsheet type definitions include JSDoc annotations for the entire API. This means that when you work with the library in your IDE, you can read method descriptions, check parameter types, and view code examples without leaving your editor. Just hover over any method or property to see the inline documentation. + +![JSDoc hints in IDE](assets/jsdoc_hints.png) diff --git a/docs/whats_new.md b/docs/whats_new.md index 0088dd01..fa58083c 100644 --- a/docs/whats_new.md +++ b/docs/whats_new.md @@ -34,6 +34,7 @@ The new release introduces significant changes in the Spreadsheet API: there is - the ability to provide custom font size in the toolbar control - `COUNTIF` and `SUMIF` functions are added into the formulas engine - The `awaitRedraw()` helper is added for Spreadsheet to detect the rendering process and perform the desired code after the component finishes its rendering +- JSDoc annotations are added to the type definitions, providing inline API descriptions, parameter types, and code examples directly in the IDE ### Fixes @@ -496,7 +497,7 @@ Version 4.3 doesn't bring any breaking changes but introduces a new way of handl - Significantly extended list of supported [Date, Financial, Math, String functions](functions.md#information-functions) (marked with *added in v4.3* label) - Support for [Lookup functions](functions.md#lookup-functions) - [Time format](number_formatting.md/#default-number-formats) is added -- The ability to define the format of times in the spreadsheet cells via the [`timeFormat`](api/spreadsheet_timeformat_config.md) property +- The ability to define the format of times in the spreadsheet cells via the [`timeFormat`](api/spreadsheet_localization_config.md) property - The ability to enter time in a cell via a time picker - [Export to JSON](api/export_json_method.md) - [Import from JSON](api/spreadsheet_load_method.md#loading-json-files) @@ -519,11 +520,11 @@ Released on November 29, 2021 - Support for [boolean operators](functions.md/#boolean-operators) - The ability to resize rows from UI - New [Vertical align](data_formatting.md/#alignment) button is added into the toolbar -- The ability to set the active sheet via the [`setActiveSheet()`](api/spreadsheet_setactivesheet_method.md) method +- The ability to set the active sheet via the `setActiveSheet()` method - The ability to remove selection from the specified cells via the [`removeSelectedCell()`](api/selection_removeselectedcell_method.md) method of the Selection object -- The ability to clear a spreadsheet or its sheet via the [`clear()`](api/spreadsheet_clear_method.md) or [`clearSheet()`](api/spreadsheet_clearsheet_method.md) method correspondingly -- New events are added: [`beforeClear`](api/spreadsheet_beforeclear_event.md), [`afterClear`](api/spreadsheet_afterclear_event.md), [`beforeSheetClear`](api/spreadsheet_beforesheetclear_event.md), [`afterSheetClear`](api/spreadsheet_aftersheetclear_event.md) -- The ability to define the format of dates in the spreadsheet via the [`dateFormat`](api/spreadsheet_dateformat_config.md) property +- The ability to clear a spreadsheet or its sheet via the [`clear()`](api/spreadsheet_clear_method.md) or `clearSheet()` method correspondingly +- New events are added: [`beforeClear`](api/spreadsheet_beforeclear_event.md), [`afterClear`](api/spreadsheet_afterclear_event.md), `beforeSheetClear`, `afterSheetClear` +- The ability to define the format of dates in the spreadsheet via the [`dateFormat`](api/spreadsheet_localization_config.md) property - [Date format is added to default number formats](number_formatting.md/#default-number-formats) ### Updates @@ -600,8 +601,8 @@ Released on March 24, 2021 - The ability to [work with multiple sheets](work_with_sheets.md) in the spreadsheet - The ability to use [cross-references in multiple sheets](work_with_sheets.md#cross-references-between-sheets) - The ability to [load several sheets](working_with_sheets.md#loading-multiple-sheets) into the spreadsheet at once -- New methods for working with [multiple sheets](working_with_sheets.md) are added: [addSheet()](api/spreadsheet_addsheet_method.md), [removeSheet()](api/spreadsheet_removesheet_method.md), [getActiveSheet()](api/spreadsheet_getactivesheet_method.md), [getSheets()](api/spreadsheet_getsheets_method.md) -- New events are added: [BeforeSheetAdd](api/spreadsheet_beforesheetadd_event.md), [AfterSheetAdd](api/spreadsheet_aftersheetadd_event.md), [BeforeSheetChange](api/spreadsheet_beforesheetchange_event.md), [AfterSheetChange](api/spreadsheet_aftersheetchange_event.md), [BeforeSheetRemove](api/spreadsheet_beforesheetremove_event.md), [AfterSheetRemove](api/spreadsheet_aftersheetremove_event.md), [BeforeSheetRename](api/spreadsheet_beforesheetrename_event.md), [AfterSheetRename](api/spreadsheet_aftersheetrename_event.md) +- New methods for working with [multiple sheets](working_with_sheets.md) are added: `addSheet()`, `removeSheet()`, `getActiveSheet()`, `getSheets()` +- New events are added: `BeforeSheetAdd`, `AfterSheetAdd`, [`BeforeSheetChange`](api/spreadsheet_beforesheetchange_event.md), [`AfterSheetChange`](api/spreadsheet_aftersheetchange_event.md), `BeforeSheetRemove`, `AfterSheetRemove`, `BeforeSheetRename`, `AfterSheetRename` - The ability to get the formula of a cell via the [getFormula()](api/spreadsheet_getformula_method.md) method ### Updates @@ -687,7 +688,7 @@ Released on October 19, 2020 - Fix the incorrect parsing of numbers when importing Excel files - Fix the issue which caused all data copied from a Google or Excel table to be inserted into one cell of the spreadsheet - Fix the incorrect work of the [editLine:false](api/spreadsheet_editline_config.md) property that caused the edit operation to finish with an error in the console -- Fix the issue with the [AfterValueChange](api/spreadsheet_aftervaluechange_event.md) event which caused the event to be called twice +- Fix the issue with the `AfterValueChange` event which caused the event to be called twice ## Version 3.1.4 diff --git a/docs/working_with_sheets.md b/docs/working_with_sheets.md index c3dff5c6..64525f01 100644 --- a/docs/working_with_sheets.md +++ b/docs/working_with_sheets.md @@ -12,9 +12,11 @@ In this article we'll discuss the details on how to implement such operations as {{note To learn how to interact with multiple sheets via the user interface, check our [User Guide](work_with_sheets.md). }} +Starting from v6.0, sheet management is handled by the **Sheet Manager** module, accessible via the `spreadsheet.sheets` property. The dedicated [Sheet Manager API](api/overview/sheetmanager_overview.md) replaces the sheet-related methods that were previously available directly on the `ISpreadsheet` instance. + ## Loading multiple sheets -To load several sheets into the spreadsheet, you should prepare data with the desired number of sheets and their configuration and pass them to the [parse()](api/spreadsheet_parse_method.md) method as a parameter. The data should be an *object*. [Check the list of attributes the object can include](api/spreadsheet_parse_method.md). +To load several sheets into the spreadsheet, you should prepare data with the desired number of sheets and their configuration and pass them to the [`parse()`](api/spreadsheet_parse_method.md) method as a parameter. The data should be an *object*. [Check the list of attributes the object can include](api/spreadsheet_parse_method.md). @@ -22,69 +24,126 @@ To load several sheets into the spreadsheet, you should prepare data with the de ## Adding a new sheet -To add a new sheet into the spreadsheet, use the [addSheet()](api/spreadsheet_addsheet_method.md) method and pass the name of the new sheet as a parameter: +To add a new sheet into the spreadsheet, use the [`sheets.add()`](api/sheetmanager_add_method.md) method and pass the name of the new sheet as a parameter: ~~~jsx -spreadsheet.addSheet("New Sheet"); -// -> "u1614669331209" +const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", { + multiSheets: true +}); +spreadsheet.parse(data); + +// Add a sheet with a custom name +const newSheetId = spreadsheet.sheets.add("Q4 Report"); +console.log(newSheetId); // e.g. "sheet_2" + +// Add a sheet with an auto-generated name +const anotherId = spreadsheet.sheets.add(); ~~~ The method returns the id of the created sheet. ## Removing a sheet -You can remove a sheet from the spreadsheet by its id via the [removeSheet()](api/spreadsheet_removesheet_method.md) method: +You can remove a sheet from the spreadsheet by its id via the [`sheets.remove()`](api/sheetmanager_remove_method.md) method: ~~~jsx -spreadsheet.removeSheet("u1614669331209"); +const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", { + multiSheets: true +}); +spreadsheet.parse(data); + +// Remove a sheet by its id +spreadsheet.sheets.remove("sheet_2"); ~~~ -Note, that a sheet won't be deleted if the number of sheets in the spreadsheet is less than 2. +Note, that a sheet won't be removed if the number of sheets in the spreadsheet is less than 2. ## Setting active sheet -To change the active sheet dynamically after initialization of the spreadsheet, use the [setActiveSheet()](api/spreadsheet_setactivesheet_method.md) method. It takes the id of a sheet as a parameter: +To change the active sheet dynamically after initialization of the spreadsheet, use the [`sheets.setActive()`](api/sheetmanager_setactive_method.md) method. It takes the id of a sheet as a parameter: ~~~jsx -spreadsheet.setActiveSheet("u1636003130922"); +const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", { + multiSheets: true +}); +spreadsheet.parse(data); + +// Switch to the second sheet +spreadsheet.sheets.setActive("sheet_2"); + +// Verify the switch +const active = spreadsheet.sheets.getActive(); +console.log(active.name); // "Sheet 2" ~~~ **Related sample:** [Spreadsheet. Set active sheet](https://snippet.dhtmlx.com/iowl449t) ## Getting active sheet -It is possible to get the sheet that is currently active by applying the [getActiveSheet()](api/spreadsheet_getactivesheet_method.md) method: +It is possible to get the sheet that is currently active by applying the [`sheets.getActive()`](api/sheetmanager_getactive_method.md) method: ~~~jsx -spreadsheet.getActiveSheet(); -// -> {name: "sheet", id: "u1614675531904"} +const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", { + multiSheets: true +}); +spreadsheet.parse(data); + +const active = spreadsheet.sheets.getActive(); +console.log(active.name); // "Sheet 1" +console.log(active.id); // "sheet_1" ~~~ The method returns an object with the name and id attributes of the currently active sheet. -## Getting sheets +## Getting all sheets -The [getSheets()](api/spreadsheet_getsheets_method.md) method allows you to get all sheets of the spreadsheet. The method returns an array with a set of sheet objects: +The [`sheets.getAll()`](api/sheetmanager_getall_method.md) method allows you to get all sheets of the spreadsheet. The method returns an array with a set of sheet objects: ~~~jsx -spreadsheet.getSheets(); -// -> [{name: "sheet1", id: "u1614669331194"}, …] +const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", { + multiSheets: true +}); +spreadsheet.parse(data); + +const allSheets = spreadsheet.sheets.getAll(); +console.log(allSheets); +// [ +// { id: "sheet_1", name: "Sheet 1" }, +// { id: "sheet_2", name: "Sheet 2" } +// ] ~~~ -## Clearing sheets +## Getting a sheet by id -There is the ability to clear the data of the specified sheet by its id via the [clearSheet()](api/spreadsheet_clearsheet_method.md) method: +To retrieve a single sheet object by its id, use the [`sheets.get()`](api/sheetmanager_get_method.md) method: ~~~jsx -spreadsheet.clearSheet("income_id"); +const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", { + multiSheets: true +}); +spreadsheet.parse(data); + +const sheet = spreadsheet.sheets.get("sheet_1"); +console.log(sheet.name); // "Sheet 1" ~~~ -**Related sample:** [Spreadsheet. Clear](https://snippet.dhtmlx.com/szmtjn72) +## Clearing sheets -To clear the currently active sheet, call the [clearSheet()](api/spreadsheet_clearsheet_method.md) method without the parameter: +There is the ability to clear the data of the specified sheet by its id via the [`sheets.clear()`](api/sheetmanager_clear_method.md) method: ~~~jsx -spreadsheet.clearSheet(); +const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", { + multiSheets: true +}); +spreadsheet.parse(data); + +// Clear a specific sheet by id +spreadsheet.sheets.clear("sheet_1"); + +// Clear the currently active sheet +spreadsheet.sheets.clear(); ~~~ -If you need to clear the whole spreadsheet at once, use the [clear()](api/spreadsheet_clear_method.md) method. +**Related sample:** [Spreadsheet. Clear](https://snippet.dhtmlx.com/szmtjn72) + +If you need to clear the whole spreadsheet at once, use the [`clear()`](api/spreadsheet_clear_method.md) method. diff --git a/docs/working_with_ssheet.md b/docs/working_with_ssheet.md index 9de59b92..c62c69b9 100644 --- a/docs/working_with_ssheet.md +++ b/docs/working_with_ssheet.md @@ -299,4 +299,4 @@ spreadsheet.clear(); **Related sample:** [Spreadsheet. Clear](https://snippet.dhtmlx.com/szmtjn72) -If you need to clear a specific sheet, use the [clearSheet()](api/spreadsheet_clearsheet_method.md) method. +If you need to clear a specific sheet, use the [sheets.clear()](api/sheetmanager_clear_method.md) method. diff --git a/sidebars.js b/sidebars.js index 92cb76ca..80033794 100644 --- a/sidebars.js +++ b/sidebars.js @@ -49,9 +49,7 @@ module.exports = { items: [ "api/spreadsheet_addcolumn_method", "api/spreadsheet_addrow_method", - "api/spreadsheet_addsheet_method", "api/spreadsheet_clear_method", - "api/spreadsheet_clearsheet_method", "api/spreadsheet_deletecolumn_method", "api/spreadsheet_deleterow_method", "api/spreadsheet_eachcell_method", @@ -59,27 +57,23 @@ module.exports = { "api/spreadsheet_fitcolumn_method", "api/spreadsheet_freezecols_method", "api/spreadsheet_freezerows_method", - "api/spreadsheet_getactivesheet_method", "api/spreadsheet_getfilter_method", "api/spreadsheet_getformat_method", "api/spreadsheet_getformula_method", - "api/spreadsheet_getsheets_method", "api/spreadsheet_getstyle_method", "api/spreadsheet_getvalue_method", "api/spreadsheet_hidecols_method", "api/spreadsheet_hiderows_method", "api/spreadsheet_hidesearch_method", "api/spreadsheet_insertlink_method", - "api/spreadsheet_islocked_method", + "api/spreadsheet_islocked_method", "api/spreadsheet_load_method", "api/spreadsheet_lock_method", "api/spreadsheet_mergecells_method", "api/spreadsheet_parse_method", "api/spreadsheet_redo_method", - "api/spreadsheet_removesheet_method", "api/spreadsheet_search_method", "api/spreadsheet_serialize_method", - "api/spreadsheet_setactivesheet_method", "api/spreadsheet_setfilter_method", "api/spreadsheet_setformat_method", "api/spreadsheet_setstyle_method", @@ -107,41 +101,19 @@ module.exports = { items: [ "api/spreadsheet_afteraction_event", "api/spreadsheet_afterclear_event", - "api/spreadsheet_aftercolumnadd_event", - "api/spreadsheet_aftercolumndelete_event", "api/spreadsheet_afterdataloaded_event", "api/spreadsheet_aftereditend_event", "api/spreadsheet_aftereditstart_event", "api/spreadsheet_afterfocusset_event", - "api/spreadsheet_afterformatchange_event", - "api/spreadsheet_afterrowadd_event", - "api/spreadsheet_afterrowdelete_event", "api/spreadsheet_afterselectionset_event", - "api/spreadsheet_aftersheetadd_event", "api/spreadsheet_aftersheetchange_event", - "api/spreadsheet_aftersheetclear_event", - "api/spreadsheet_aftersheetremove_event", - "api/spreadsheet_aftersheetrename_event", - "api/spreadsheet_afterstylechange_event", - "api/spreadsheet_aftervaluechange_event", "api/spreadsheet_beforeaction_event", "api/spreadsheet_beforeclear_event", - "api/spreadsheet_beforecolumnadd_event", - "api/spreadsheet_beforecolumndelete_event", "api/spreadsheet_beforeeditend_event", "api/spreadsheet_beforeeditstart_event", "api/spreadsheet_beforefocusset_event", - "api/spreadsheet_beforeformatchange_event", - "api/spreadsheet_beforerowadd_event", - "api/spreadsheet_beforerowdelete_event", "api/spreadsheet_beforeselectionset_event", - "api/spreadsheet_beforesheetadd_event", "api/spreadsheet_beforesheetchange_event", - "api/spreadsheet_beforesheetclear_event", - "api/spreadsheet_beforesheetremove_event", - "api/spreadsheet_beforesheetrename_event", - "api/spreadsheet_beforestylechange_event", - "api/spreadsheet_beforevaluechange_event", "api/spreadsheet_groupfill_event" ] }, @@ -160,7 +132,6 @@ module.exports = { }, items: [ "api/spreadsheet_colscount_config", - "api/spreadsheet_dateformat_config", "api/spreadsheet_editline_config", "api/spreadsheet_exportmodulepath_config", "api/spreadsheet_formats_config", @@ -170,10 +141,28 @@ module.exports = { "api/spreadsheet_multisheets_config", "api/spreadsheet_readonly_config", "api/spreadsheet_rowscount_config", - "api/spreadsheet_timeformat_config", "api/spreadsheet_toolbarblocks_config" ] }, + { + type: "category", + label: "Sheet Manager API", + collapsible: true, + collapsed: true, + link: { + type: 'doc', + id: "api/overview/sheetmanager_overview" + }, + items: [ + "api/sheetmanager_add_method", + "api/sheetmanager_clear_method", + "api/sheetmanager_get_method", + "api/sheetmanager_getactive_method", + "api/sheetmanager_getall_method", + "api/sheetmanager_remove_method", + "api/sheetmanager_setactive_method" + ] + }, { type: "category", label: "Selection methods", diff --git a/src/css/custom.css b/src/css/custom.css index d9768617..872d5db9 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -117,6 +117,12 @@ table th:first-child { width: 25%; } +.deprecated-methods-table { overflow-x: auto; } + +.deprecated-events-table table th:nth-child(1) { width: 20%; } +.deprecated-events-table table th:nth-child(2) { width: 45%; } +.deprecated-events-table table th:nth-child(3) { width: 35%; } + /* end styles for tables */