Skip to content

Commit 441d51b

Browse files
[add] deprecated doc page
1 parent bba3d00 commit 441d51b

File tree

2 files changed

+57
-0
lines changed

2 files changed

+57
-0
lines changed

docs/deprecated_doc.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
sidebar_label: Deprecated documentation 2.1
3+
title: Deprecated documentation
4+
description: You can learn about deprecated documentation 2.1 of the DHTMLX JavaScript Spreadsheet library. Please, use the updated 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.
5+
---
6+
7+
# Deprecated documentation 2.1
8+
9+
:::note
10+
The [**API of version 2.1**](https://docs.dhtmlx.com/spreadsheet__reference.html) described in the deprecated documentation is still available, but it is incompatible with the [**API starting from version 3.0**](api/api_overview.md).
11+
:::
12+
13+
This list of changes will help you to migrate from the [version 2.1](https://docs.dhtmlx.com/spreadsheet__index.html) where DHTMLX Spreadsheet was PHP-based, to the totally renewed version 3.0, in which the component is totally built on JavaScript. Check the list below to explore all the changes.
14+
15+
## Changed API
16+
17+
- `getStyle()` -> [`spreadsheet.getStyle()`](api/spreadsheet_getstyle_method.md) - returns styles applied to a cell(s)
18+
- `getValue()` -> [`spreadsheet.getValue()`](api/spreadsheet_getvalue_method.md) - returns an object with the value(s) of a cell(s)
19+
- `setStyle()` -> [`spreadsheet.setStyle()`](api/spreadsheet_setstyle_method.md) - sets style for a cell or a range of cells
20+
- `setValue()` -> [`spreadsheet.setValue()`](api/spreadsheet_setvalue_method.md) - sets value for a cell or a range of cells
21+
- `lock()` -> [`spreadsheet.lock()`](api/spreadsheet_lock_method.md) - locks a cell or a range of cells
22+
- `unlock()` -> [`spreadsheet.unlock()`](api/spreadsheet_unlock_method.md) - unlocks a locked cell or a range of cells
23+
24+
## Removed API
25+
26+
### Spreadsheet class
27+
28+
- `getCell()`
29+
- `getCells()`
30+
- `isCell()`
31+
- `setSheetId()`
32+
33+
### SpreadsheetCell
34+
35+
- `calculate()`
36+
- `exists()`
37+
- `getAlign()`
38+
- `getBgColor()`
39+
- `getCalculatedValue()`
40+
- `getColIndex()`
41+
- `getColName()`
42+
- `getColor()`
43+
- `getCoords()`
44+
- `getValidator()`
45+
- `isBold()`
46+
- `isIncorrect()`
47+
- `isItalic()`
48+
- `parseStyle()`
49+
- `serializeStyle()`
50+
- `setAlign()`
51+
- `setBgColor()`
52+
- `setBold()`
53+
- `setColor()`
54+
- `setItalic()`
55+
- `setLocked()`
56+
- `setValidator()`

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ module.exports = {
2424
items: [
2525
"whats_new",
2626
"migration",
27+
"deprecated_doc",
2728
],
2829
},
2930
{

0 commit comments

Comments
 (0)