Merge pull request #19 from DHTMLX/freezing-columns-and-rows-3667

[add] docs on freezing/unfreezing rows and columns functionality

Author: mafanya23

docs/api/api_overview.md

@@ -34,6 +34,8 @@ Parameters:
 | [](api/spreadsheet_eachcell_method.md)       | @getshort(api/spreadsheet_eachcell_method.md)       |
 | [](api/spreadsheet_endedit_method.md)        | @getshort(api/spreadsheet_endedit_method.md)        |
 | [](api/spreadsheet_fitcolumn_method.md)      | @getshort(api/spreadsheet_fitcolumn_method.md)      |
+| [](api/spreadsheet_freezecols_method.md)     | @getshort(api/spreadsheet_freezecols_method.md)     |
+| [](api/spreadsheet_freezerows_method.md)     | @getshort(api/spreadsheet_freezerows_method.md)     |
 | [](api/spreadsheet_getactivesheet_method.md) | @getshort(api/spreadsheet_getactivesheet_method.md) |
 | [](api/spreadsheet_getfilter_method.md)      | @getshort(api/spreadsheet_getfilter_method.md)      |
 | [](api/spreadsheet_getformat_method.md)      | @getshort(api/spreadsheet_getformat_method.md)      |
@@ -60,6 +62,8 @@ Parameters:
 | [](api/spreadsheet_setvalue_method.md)       | @getshort(api/spreadsheet_setvalue_method.md)       |
 | [](api/spreadsheet_startedit_method.md)      | @getshort(api/spreadsheet_startedit_method.md)      |
 | [](api/spreadsheet_undo_method.md)           | @getshort(api/spreadsheet_undo_method.md)           |
+| [](api/spreadsheet_unfreezecols_method.md)   | @getshort(api/spreadsheet_unfreezecols_method.md)   |
+| [](api/spreadsheet_unfreezerows_method.md)   | @getshort(api/spreadsheet_unfreezerows_method.md)   |
 | [](api/spreadsheet_unlock_method.md)         | @getshort(api/spreadsheet_unlock_method.md)         |
 
 ## Spreadsheet events
@@ -114,15 +118,14 @@ Parameters:
 | [](api/spreadsheet_exportmodulepath_config.md) | @getshort(api/spreadsheet_exportmodulepath_config.md) |
 | [](api/spreadsheet_formats_config.md)          | @getshort(api/spreadsheet_formats_config.md)          |
 | [](api/spreadsheet_importmodulepath_config.md) | @getshort(api/spreadsheet_importmodulepath_config.md) |
-| [](api/spreadsheet_leftsplit_config.md)        | @getshort(api/spreadsheet_leftsplit_config.md)        |
 | [](api/spreadsheet_localization_config.md)     | @getshort(api/spreadsheet_localization_config.md)     |
 | [](api/spreadsheet_menu_config.md)             | @getshort(api/spreadsheet_menu_config.md)             |
 | [](api/spreadsheet_multisheets_config.md)      | @getshort(api/spreadsheet_multisheets_config.md)      |
 | [](api/spreadsheet_readonly_config.md)         | @getshort(api/spreadsheet_readonly_config.md)         |
 | [](api/spreadsheet_rowscount_config.md)        | @getshort(api/spreadsheet_rowscount_config.md)        |
 | [](api/spreadsheet_timeformat_config.md)       | @getshort(api/spreadsheet_timeformat_config.md)       |
 | [](api/spreadsheet_toolbarblocks_config.md)    | @getshort(api/spreadsheet_toolbarblocks_config.md)    |
-| [](api/spreadsheet_topsplit_config.md)         | @getshort(api/spreadsheet_topsplit_config.md)         |
+
 
 ## Selection methods
 

docs/api/overview/actions_overview.md

@@ -74,10 +74,12 @@ spreadsheet.events.on("beforeColumnAdd", function(cell){
 | **setValidation**    | The action is executed when setting data validation for a cell                                                                                                                                          |
 | **sortCells**        | The action is executed when sorting data in spreadsheet                                                                                                                                                 |
 | **setCellStyle**     | The action is executed when changing the style of a cell                                                                                                                                                |
+| **toggleFreeze**     | The action is executed when freezing/unfreezing columns/rows                                                                                                       |
 | **unmerge**          | The action is executed when splitting cells                                                                                                                                                             |
 
 **Change log:**
 
+- The **toggleFreeze** action was added in v5.2
 - The **merge**, **unmerge**, **filter**, **fitColumn**, **insertLink** actions were added in v5.0
 
 **Related sample:** [Spreadsheet. Actions](https://snippet.dhtmlx.com/efcuxlkt)

docs/api/overview/methods_overview.md

@@ -18,6 +18,8 @@ description: You can have a Methods overview of the DHTMLX JavaScript Spreadshee
 | [](../spreadsheet_eachcell_method.md)       | @getshort(../spreadsheet_eachcell_method.md)       |
 | [](../spreadsheet_endedit_method.md)        | @getshort(../spreadsheet_endedit_method.md)        |
 | [](../spreadsheet_fitcolumn_method.md)      | @getshort(../spreadsheet_fitcolumn_method.md)      |
+| [](../spreadsheet_freezecols_method.md)     | @getshort(../spreadsheet_freezecols_method.md)     |
+| [](../spreadsheet_freezerows_method.md)     | @getshort(../spreadsheet_freezerows_method.md)     |
 | [](../spreadsheet_getactivesheet_method.md) | @getshort(../spreadsheet_getactivesheet_method.md) |
 | [](../spreadsheet_getfilter_method.md)      | @getshort(../spreadsheet_getfilter_method.md)      |
 | [](../spreadsheet_getformat_method.md)      | @getshort(../spreadsheet_getformat_method.md)      |
@@ -44,4 +46,6 @@ description: You can have a Methods overview of the DHTMLX JavaScript Spreadshee
 | [](../spreadsheet_setvalue_method.md)       | @getshort(../spreadsheet_setvalue_method.md)       |
 | [](../spreadsheet_startedit_method.md)      | @getshort(../spreadsheet_startedit_method.md)      |
 | [](../spreadsheet_undo_method.md)           | @getshort(../spreadsheet_undo_method.md)           |
+| [](../spreadsheet_unfreezecols_method.md)   | @getshort(../spreadsheet_unfreezecols_method.md)   |
+| [](../spreadsheet_unfreezerows_method.md)   | @getshort(../spreadsheet_unfreezerows_method.md)   |
 | [](../spreadsheet_unlock_method.md)         | @getshort(../spreadsheet_unlock_method.md)         |

docs/api/overview/properties_overview.md

@@ -14,12 +14,11 @@ description: You can have a Properties overview of the DHTMLX JavaScript Spreads
 | [](../spreadsheet_exportmodulepath_config.md) | @getshort(../spreadsheet_exportmodulepath_config.md) |
 | [](../spreadsheet_formats_config.md)          | @getshort(../spreadsheet_formats_config.md)          |
 | [](../spreadsheet_importmodulepath_config.md) | @getshort(../spreadsheet_importmodulepath_config.md) |
-| [](../spreadsheet_leftsplit_config.md)        | @getshort(../spreadsheet_leftsplit_config.md)        |
 | [](../spreadsheet_localization_config.md)     | @getshort(../spreadsheet_localization_config.md)     |
 | [](../spreadsheet_menu_config.md)             | @getshort(../spreadsheet_menu_config.md)             |
 | [](../spreadsheet_multisheets_config.md)      | @getshort(../spreadsheet_multisheets_config.md)      |
 | [](../spreadsheet_readonly_config.md)         | @getshort(../spreadsheet_readonly_config.md)         |
 | [](../spreadsheet_rowscount_config.md)        | @getshort(../spreadsheet_rowscount_config.md)        |
 | [](../spreadsheet_timeformat_config.md)       | @getshort(../spreadsheet_timeformat_config.md)       |
 | [](../spreadsheet_toolbarblocks_config.md)    | @getshort(../spreadsheet_toolbarblocks_config.md)    |
-| [](../spreadsheet_topsplit_config.md)         | @getshort(../spreadsheet_topsplit_config.md)         |
+

docs/api/spreadsheet_freezecols_method.md

@@ -0,0 +1,37 @@
+---
+sidebar_label: freezeCols() 
+title: freezeCols method
+description: You can learn about the freezeCols method in the documentation of the DHTMLX JavaScript Spreadsheet library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Spreadsheet.
+---
+
+# freezeCols()
+
+### Description
+
+@short: Fixes ("freezes") columns
+
+### Usage
+
+~~~jsx
+freezeCols(cell?: string): void;
+~~~
+
+### Parameters
+
+- `cell` - (optional) the id of the cell used to define the id of a column. If the cell id isn't passed, the currently selected cell will be used 
+
+### Example
+
+~~~jsx 
+spreadsheet.freezeCols("B2"); // the columns up to the "B" column will be fixed
+spreadsheet.freezeCols("sheet2!B2"); // the columns up to the "B" column in "sheet2" will be fixed
+~~~
+
+**Related articles:** [Work with Spreadsheet](working_with_ssheet.md/#freezingunfreezing-rows-and-columns)
+
+**Related API:** [`unfreezeCols()`](api/spreadsheet_unfreezecols_method.md/)
+
+**Related sample:** [Spreadsheet. Freezing columns and rows via API](https://snippet.dhtmlx.com/a12xd1mn)
+
+**Change log:** 
+Added in v5.2

docs/api/spreadsheet_freezerows_method.md

@@ -0,0 +1,37 @@
+---
+sidebar_label: freezeRows() 
+title: freezeRows method
+description: You can learn about the freezeRows method in the documentation of the DHTMLX JavaScript Spreadsheet library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Spreadsheet.
+---
+
+# freezeRows()
+
+### Description
+
+@short: Fixes ("freezes") rows
+
+### Usage
+
+~~~jsx
+freezeRows(cell?: string): void;
+~~~
+
+### Parameters
+
+- `cell` - (optional) the id of the cell used to define the id of a row. If the cell id isn't passed, the currently selected cell will be used 
+
+### Example
+
+~~~jsx 
+spreadsheet.freezeRows("B2"); // the rows up to the second row will be fixed
+spreadsheet.freezeRows("sheet2!B2"); // the rows up to the second row in "sheet2" will be fixed
+~~~
+
+**Related articles:** [Work with Spreadsheet](working_with_ssheet.md/#freezingunfreezing-rows-and-columns)
+
+**Related API:** [`unfreezeRows()`](api/spreadsheet_unfreezerows_method.md/)
+
+**Related sample:** [Spreadsheet. Freezing columns and rows via API](https://snippet.dhtmlx.com/a12xd1mn)
+
+**Change log:** 
+Added in v5.2

docs/api/spreadsheet_leftsplit_config.md

@@ -65,7 +65,11 @@ parse({
                     to: { column: index, row: index }
                 },
                 // more objects
-            ]
+            ],
+            freeze?: {
+               col?: number,
+               row?: number,
+            }
         },
         // more sheet objects
     ]      
@@ -116,6 +120,10 @@ If you need to create a data set *for several sheets* at once, specify data as a
         - `to` - an object which defines the position of the last cell from a range:
             - `column` - the index of the column
             - `row` - the index of the row
+    - `freeze` - (optional) an object that sets and adjusts fixed columns/rows for particular sheets. It may contain the following properties:
+        - `col` - (optional) specifies the number of fixed columns, for example, 2 
+        - `row` - (optional) specifies the number of fixed rows, for example, 2 
+        The default value of the parameter is `freeze: {col: 0, row: 0}`
 
 :::info
 In case the [`multisheets`](api/spreadsheet_multisheets_config.md) configuration option is set to *false*, only one sheet will be created.

docs/api/spreadsheet_parse_method.md

@@ -0,0 +1,37 @@
+---
+sidebar_label: unfreezeCols() 
+title: unfreezeCols method
+description: You can learn about the unfreezeCols 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.
+---
+
+# unfreezeCols()
+
+### Description
+
+@short: Unfreezes the fixed ("frozen") columns
+
+### Usage
+
+~~~jsx
+unfreezeCols(cell?: string): void;
+~~~
+
+### Parameters
+
+- `cell` - (optional) the id of the cell used to define the id of a column. If the cell id isn't passed, the currently selected cell will be used 
+
+### Example
+
+~~~jsx 
+spreadsheet.unfreezeCols(); // fixed columns in the current sheet will be unfrozen
+spreadsheet.unfreezeCols("sheet2!A1"); // fixed columns in "sheet2" will be unfrozen
+~~~
+
+**Related articles:** [Work with Spreadsheet](working_with_ssheet.md/#freezingunfreezing-rows-and-columns)
+
+**Related API:** [`freezeCols()`](api/spreadsheet_freezecols_method.md/)
+
+**Related sample:** [Spreadsheet. Freezing columns and rows via API](https://snippet.dhtmlx.com/a12xd1mn)
+
+**Change log:** 
+Added in v5.2