Skip to content
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion docs/api/eventsbus_detach_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ spreadsheet.events.on("StyleChange", handler2, marker);
spreadsheet.events.detach("StyleChange", marker);
~~~

**Related articles:** [Event Handling](handling_events.md)
**Related article:** [Event Handling](handling_events.md)
2 changes: 1 addition & 1 deletion docs/api/eventsbus_fire_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ spreadsheet.events.on("CustomEvent", function(param1, param2){
const res = spreadsheet.events.fire("CustomEvent", [12, "abc"]);
~~~

**Related articles:** [Event Handling](handling_events.md)
**Related article:** [Event Handling](handling_events.md)
2 changes: 1 addition & 1 deletion docs/api/eventsbus_on_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,6 @@ See the full list of the Spreadsheet events [here](api/api_overview.md#spreadshe
You can attach several handlers to the same event and all of them are executed. If some handlers return `false`, the related operations are blocked. Event handlers are processed in the same order that they are attached.
:::

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

**Related sample:** [Spreadsheet. Events](https://snippet.dhtmlx.com/2vkjyvsi)
2 changes: 1 addition & 1 deletion docs/api/export_json_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@ spreadsheet.export.json();

**Changelog:** Added in v4.3

**Related articles:** [Data loading and export](loading_data.md)
**Related article:** [Data loading and export](loading_data.md)

**Related sample:** [Spreadsheet. Export/import JSON](https://snippet.dhtmlx.com/e3xct53l)
2 changes: 1 addition & 1 deletion docs/api/export_xlsx_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,6 @@ Note that the component supports export to Excel files with the `.xlsx` extensio
DHTMLX Spreadsheet uses the WebAssembly-based library [Json2Excel](https://github.com/dhtmlx/json2excel) to export data to Excel. [Check the details](loading_data.md#exporting-data).
:::

**Related articles:** [Data loading and export](loading_data.md)
**Related article:** [Data loading and export](loading_data.md)

**Related sample:** [Spreadsheet. Export Xlsx](https://snippet.dhtmlx.com/btyo3j8s)
2 changes: 1 addition & 1 deletion docs/api/selection_getfocusedcell_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ spreadsheet.selection.setFocusedCell("D4");
const focused = spreadsheet.selection.getFocusedCell(); // ->"D4"
~~~

**Related articles:** [Work with Spreadsheet](working_with_ssheet.md)
**Related article:** [Work with Spreadsheet](working_with_ssheet.md)
2 changes: 1 addition & 1 deletion docs/api/selection_getselectedcell_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ spreadsheet.selection.setSelectedCell("B7,B3,D4,D6,E4:E8");
const selected = spreadsheet.selection.getSelectedCell(); // -> "B7,B3,D4,D6,E4:E8"
~~~

**Related articles:** [Work with Spreadsheet](working_with_ssheet.md)
**Related article:** [Work with Spreadsheet](working_with_ssheet.md)
2 changes: 1 addition & 1 deletion docs/api/selection_removeselectedcell_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,6 @@ spreadsheet.selection.removeSelectedCell("A3:A6,C2");

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

**Related articles:** [Work with Spreadsheet](working_with_ssheet.md)
**Related article:** [Work with Spreadsheet](working_with_ssheet.md)

**Related sample:** [Spreadsheet. Remove selection](https://snippet.dhtmlx.com/u4j76cuh)
2 changes: 1 addition & 1 deletion docs/api/selection_setfocusedcell_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ spreadsheet.parse(data);
spreadsheet.selection.setFocusedCell("D4");
~~~

**Related articles:** [Work with Spreadsheet](working_with_ssheet.md)
**Related article:** [Work with Spreadsheet](working_with_ssheet.md)
2 changes: 1 addition & 1 deletion docs/api/selection_setselectedcell_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ spreadsheet.selection.setSelectedCell("B1:B5");
spreadsheet.selection.setSelectedCell("B7,B3,D4,D6,E4:E8");
~~~

**Related articles:** [Work with Spreadsheet](working_with_ssheet.md)
**Related article:** [Work with Spreadsheet](working_with_ssheet.md)
6 changes: 3 additions & 3 deletions docs/api/sheetmanager_add_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ add: (name?: string) => Id;

### Parameters

- `name` - (`string`) optional, the displayed name for the new sheet tab. If omitted, a default name is assigned.
- `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.
- `Id` - (*string | number*) the unique identifier of the newly created sheet.

### Example

Expand All @@ -48,4 +48,4 @@ const anotherSheetId = spreadsheet.sheets.add();

**Change log:** Added in v6.0

**Related articles:** [Working with sheets](working_with_sheets.md)
**Related article:** [Working with sheets](working_with_sheets.md)
4 changes: 2 additions & 2 deletions docs/api/sheetmanager_clear_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ 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.
- `id` - (*string | number*) optional, the unique identifier of the sheet to clear. If omitted, the currently active sheet is cleared.

### Example

Expand All @@ -39,4 +39,4 @@ spreadsheet.sheets.clear();

**Change log:** Added in v6.0

**Related articles:** [Working with sheets](working_with_sheets.md)
**Related article:** [Working with sheets](working_with_sheets.md)
6 changes: 3 additions & 3 deletions docs/api/sheetmanager_get_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ get: (id: Id) => ISheet;

### Parameters

- `id` - (`string | number`) required, the unique identifier of the sheet to retrieve.
- `id` - (*string | number*) required, the unique identifier of the sheet to retrieve.

### Returns

- `ISheet` - (`object`) the sheet object matching the given id.
- `ISheet` - (*object*) the sheet object matching the given id.

### Example

Expand All @@ -38,4 +38,4 @@ console.log(sheet.name); // "Sheet 1"

**Change log:** Added in v6.0

**Related articles:** [Working with sheets](working_with_sheets.md)
**Related article:** [Working with sheets](working_with_sheets.md)
4 changes: 2 additions & 2 deletions docs/api/sheetmanager_getactive_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ getActive: () => ISheet;

### Returns

- `ISheet` - (`object`) the currently active sheet object with the `id` and `name` properties.
- `ISheet` - (*object*) the currently active sheet object with the `id` and `name` properties.

### Example

Expand All @@ -35,4 +35,4 @@ console.log(active.id); // "sheet_1"

**Change log:** Added in v6.0

**Related articles:** [Working with sheets](working_with_sheets.md)
**Related article:** [Working with sheets](working_with_sheets.md)
4 changes: 2 additions & 2 deletions docs/api/sheetmanager_getall_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ getAll: () => ISheet[];

### Returns

- `ISheet[]` - (`array`) an array of sheet objects.
- `ISheet[]` - (*array*) an array of sheet objects.

### Example

Expand All @@ -42,4 +42,4 @@ console.log(allSheets);

**Change log:** Added in v6.0

**Related articles:** [Working with sheets](working_with_sheets.md)
**Related article:** [Working with sheets](working_with_sheets.md)
4 changes: 2 additions & 2 deletions docs/api/sheetmanager_remove_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ remove: (id: Id) => void;

### Parameters

- `id` - (`string | number`) required, the unique identifier of the sheet to remove.
- `id` - (*string | number*) required, the unique identifier of the sheet to remove.

### Example

Expand All @@ -42,4 +42,4 @@ spreadsheet.sheets.remove("sheet_2");

**Change log:** Added in v6.0

**Related articles:** [Working with sheets](working_with_sheets.md)
**Related article:** [Working with sheets](working_with_sheets.md)
4 changes: 2 additions & 2 deletions docs/api/sheetmanager_setactive_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ setActive: (id: Id) => void;

### Parameters

- `id` - (`string | number`) required, the unique identifier of the sheet to activate.
- `id` - (*string | number*) required, the unique identifier of the sheet to activate.

### Example

Expand All @@ -40,4 +40,4 @@ console.log(active.name); // "Sheet 2"

**Change log:** Added in v6.0

**Related articles:** [Working with sheets](working_with_sheets.md)
**Related article:** [Working with sheets](working_with_sheets.md)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_addcolumn_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ spreadsheet.parse(data);
spreadsheet.addColumn("G1");
~~~

**Related articles:** [Work with Spreadsheet](working_with_ssheet.md#addingremoving-rows-and-columns)
**Related article:** [Work with Spreadsheet](working_with_ssheet.md#addingremoving-rows-and-columns)
6 changes: 3 additions & 3 deletions docs/api/spreadsheet_addformula_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ addFormula: (name: string, handler: mathFunction) => void;

### Parameters

- `name` - (`string`) required, the formula name (case-insensitive, stored as uppercase)
- `handler` - (`function`) required, a callback function that processes the input arguments (strings, numbers, booleans, or arrays of these) and returns a single value
- `name` - (*string*) required, the formula name (case-insensitive, stored as uppercase)
- `handler` - (*function*) required, a callback function that processes the input arguments (strings, numbers, booleans, or arrays of these) and returns a single value

:::note
The `handler` callback function must be synchronous. Using `Promise` or `fetch` inside the function is not allowed.
Expand All @@ -52,4 +52,4 @@ spreadsheet.parse([

**Related sample:** [Spreadsheet. Add custom formula](https://snippet.dhtmlx.com/wvxdlahp)

**Related articles:** [Formulas and functions](functions.md#custom-formulas)
**Related article:** [Formulas and functions](functions.md#custom-formulas)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_addrow_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ spreadsheet.parse(data);
spreadsheet.addRow("G2");
~~~

**Related articles:** [Work with Spreadsheet](working_with_ssheet.md#addingremoving-rows-and-columns)
**Related article:** [Work with Spreadsheet](working_with_ssheet.md#addingremoving-rows-and-columns)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_afterclear_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ spreadsheet.events.on("afterClear", function(){

**Changelog:** Added in v4.2

**Related articles:** [Event handling](handling_events.md)
**Related article:** [Event handling](handling_events.md)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_afterdataloaded_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ spreadsheet.events.on("afterDataLoaded", () => {

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

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

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

2 changes: 1 addition & 1 deletion docs/api/spreadsheet_aftereditend_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ spreadsheet.events.on("afterEditEnd", function(cell, value){
});
~~~

**Related articles:** [Event handling](handling_events.md)
**Related article:** [Event handling](handling_events.md)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_aftereditstart_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ spreadsheet.events.on("afterEditStart", function(cell, value){
});
~~~

**Related articles:** [Event handling](handling_events.md)
**Related article:** [Event handling](handling_events.md)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_afterfocusset_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ spreadsheet.events.on("afterFocusSet", function(cell){
});
~~~

**Related articles:** [Event handling](handling_events.md)
**Related article:** [Event handling](handling_events.md)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_afterselectionset_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ spreadsheet.events.on("afterSelectionSet", function(cell){
});
~~~

**Related articles:** [Event handling](handling_events.md)
**Related article:** [Event handling](handling_events.md)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_aftersheetchange_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ spreadsheet.events.on("afterSheetChange", function(sheet) {

**Changelog:** Added in v4.1

**Related articles:** [Event handling](handling_events.md)
**Related article:** [Event handling](handling_events.md)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_beforeclear_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ spreadsheet.events.on("beforeClear", function(){

**Changelog:** Added in v4.2

**Related articles:** [Event handling](handling_events.md)
**Related article:** [Event handling](handling_events.md)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_beforeeditend_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ spreadsheet.events.on("beforeEditEnd", function(cell, value){
});
~~~

**Related articles:** [Event handling](handling_events.md)
**Related article:** [Event handling](handling_events.md)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_beforeeditstart_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ spreadsheet.events.on("beforeEditStart", function(cell, value){
});
~~~

**Related articles:** [Event handling](handling_events.md)
**Related article:** [Event handling](handling_events.md)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_beforefocusset_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ spreadsheet.events.on("beforeFocusSet", function(cell){
});
~~~

**Related articles:** [Event handling](handling_events.md)
**Related article:** [Event handling](handling_events.md)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_beforeselectionset_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ spreadsheet.events.on("beforeSelectionSet", function(cell){
});
~~~

**Related articles:** [Event handling](handling_events.md)
**Related article:** [Event handling](handling_events.md)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_beforesheetchange_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ spreadsheet.events.on("beforeSheetChange", function(sheet) {

**Changelog:** Added in v4.1

**Related articles:** [Event handling](handling_events.md)
**Related article:** [Event handling](handling_events.md)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_clear_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ spreadsheet.clear();

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

**Related articles:** [Clearing spreadsheet](working_with_ssheet.md#clearing-spreadsheet)
**Related article:** [Clearing spreadsheet](working_with_ssheet.md#clearing-spreadsheet)

**Related sample:** [Spreadsheet. Clear](https://snippet.dhtmlx.com/szmtjn72)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_colscount_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ const spreadsheet = new dhx.Spreadsheet("spreadsheet", {
});
~~~

**Related articles:** [Configuration](configuration.md#number-of-rows-and-columns)
**Related article:** [Configuration](configuration.md#number-of-rows-and-columns)

**Related sample:** [Spreadsheet. Full Toolbar](https://snippet.dhtmlx.com/kpm017nx)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_deletecolumn_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ spreadsheet.deleteColumn("G2");
You can delete several columns by providing a range of cells' ids as a parameter of the method, for example: "A1:C3".
:::

**Related articles:** [Work with Spreadsheet](working_with_ssheet.md#addingremoving-rows-and-columns)
**Related article:** [Work with Spreadsheet](working_with_ssheet.md#addingremoving-rows-and-columns)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_deleterow_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ spreadsheet.deleteRow("G2");
You can delete several rows by providing a range of cells' ids as a parameter of the method, for example: "A1:C3".
:::

**Related articles:** [Work with Spreadsheet](working_with_ssheet.md#addingremoving-rows-and-columns)
**Related article:** [Work with Spreadsheet](working_with_ssheet.md#addingremoving-rows-and-columns)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_eachcell_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,6 @@ spreadsheet.menu.events.on("click", function (id) {
});
~~~

**Related articles:** [Customization](customization.md#menu)
**Related article:** [Customization](customization.md#menu)

**Related sample**: [Spreadsheet. Menu](https://snippet.dhtmlx.com/2mlv2qaz)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_editline_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@ const spreadsheet = new dhx.Spreadsheet("spreadsheet", {
});
~~~

**Related articles:** [Configuration](configuration.md#editing-bar)
**Related article:** [Configuration](configuration.md#editing-bar)

**Related sample:** [Spreadsheet. Disabled Line](https://snippet.dhtmlx.com/unem2jkh)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_endedit_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ spreadsheet.parse(data);
spreadsheet.endEdit();
~~~

**Related articles:** [Work with Spreadsheet](working_with_cells.md#editing-a-cell)
**Related article:** [Work with Spreadsheet](working_with_cells.md#editing-a-cell)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_exportmodulepath_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,6 @@ To export files, you need to set the path to the *worker.js* file of the [Json2E
- use `"../libs/json2excel/x.x/worker.js?vx"` for a specific version (replace `x.x` with the version deployed on your server)


**Related articles:** [Data loading and export](loading_data.md#exporting-data)
**Related article:** [Data loading and export](loading_data.md#exporting-data)

**Related sample:** [Spreadsheet. Custom Import Export Path](https://snippet.dhtmlx.com/wykwzfhm)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_fitcolumn_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ spreadsheet.fitColumn("G2");

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

**Related articles:** [Work with Spreadsheet](working_with_ssheet.md#autofit-column-width)
**Related article:** [Work with Spreadsheet](working_with_ssheet.md#autofit-column-width)
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_freezecols_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ 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 article:** [Work with Spreadsheet](working_with_ssheet.md#freezingunfreezing-rows-and-columns)

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

Expand Down
2 changes: 1 addition & 1 deletion docs/api/spreadsheet_freezerows_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ spreadsheet.freezeRows("B2"); // the rows up to the "2" row will be fixed
spreadsheet.freezeRows("sheet2!B2"); // the rows up to the "2" row in "sheet2" will be fixed
~~~

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

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

Expand Down
Loading