Skip to content

Commit ecaff4b

Browse files
authored
Docs: Add links to API reference to the methods description in the basic-operations guide (#1557)
Add links to API reference to the methods description in the basic-operations guide
1 parent 376e740 commit ecaff4b

1 file changed

Lines changed: 31 additions & 31 deletions

File tree

docs/guide/basic-operations.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,16 @@ absolute, in all sheets affected by the change.
1515

1616
Operations affecting only the dependency graph should not decrease
1717
performance. However, multiple operations that have an impact on
18-
calculation results may affect performance; these are `clearSheet`,
19-
`setSheetContent`, `setCellContents`, `addNamedExpression`,
20-
`changeNamedExpression`, and `removeNamedExpression`. It is advised
18+
calculation results may affect performance; these are [`clearSheet`](../api/classes/hyperformula.md#clearsheet),
19+
[`setSheetContent`](../api/classes/hyperformula.md#setsheetcontent), [`setCellContents`](../api/classes/hyperformula.md#setcellcontents), [`addNamedExpression`](../api/classes/hyperformula.md#addnamedexpression),
20+
[`changeNamedExpression`](../api/classes/hyperformula.md#changenamedexpression), and [`removeNamedExpression`](../api/classes/hyperformula.md#removenamedexpression). It is advised
2121
to [batch](batch-operations.md) them.
2222

2323
## Sheets
2424

2525
### Adding a sheet
2626

27-
A sheet can be added by using the `addSheet` method. You can pass a
27+
A sheet can be added by using the [`addSheet`](../api/classes/hyperformula.md#addsheet) method. You can pass a
2828
name for it or leave it without a parameter. In the latter case the
2929
method will create an autogenerated name for it. That name can then
3030
be returned for further use.
@@ -37,7 +37,7 @@ const myNewSheet = hfInstance.addSheet();
3737
hfInstance.addSheet('SheetName');
3838
```
3939

40-
You can also count sheets by using the `countSheets` method. This
40+
You can also count sheets by using the [`countSheets`](../api/classes/hyperformula.md#countsheets) method. This
4141
method does not require any parameters.
4242

4343
```javascript
@@ -47,7 +47,7 @@ const sheetsCount = hfInstance.countSheets();
4747

4848
### Removing a sheet
4949

50-
A sheet can be removed by using the `removeSheet` method. To do that
50+
A sheet can be removed by using the [`removeSheet`](../api/classes/hyperformula.md#removesheet) method. To do that
5151
you need to pass a mandatory parameter: the ID of a sheet to be
5252
removed.
5353
This method returns [an array of changed cells](#changes-array).
@@ -59,13 +59,13 @@ const changes = hfInstance.removeSheet(0);
5959

6060
### Renaming a sheet
6161

62-
A sheet can be renamed by using the `renameSheet` method. You need to
62+
A sheet can be renamed by using the [`renameSheet`](../api/classes/hyperformula.md#renamesheet) method. You need to
6363
pass the ID of a sheet you want to rename (you can get it with the
64-
`getSheetId` method only if you know its name) along with a new name
64+
[`getSheetId`](../api/classes/hyperformula.md#getsheetid) method only if you know its name) along with a new name
6565
as the first and second parameters, respectively.
6666

6767
```javascript
68-
// rename the first sheet
68+
// rename the first sheet
6969
hfInstance.renameSheet(0, 'NewSheetName');
7070

7171
// you can retrieve the sheet ID if you know its name
@@ -77,7 +77,7 @@ hfInstance.renameSheet(sheetID, 'AnotherNewName');
7777

7878
### Clearing a sheet
7979

80-
A sheet's content can be cleared with the `clearSheet` method. You need
80+
A sheet's content can be cleared with the [`clearSheet`](../api/classes/hyperformula.md#clearsheet) method. You need
8181
to provide the ID of a sheet whose content you want to clear.
8282
This method returns [an array of changed cells](#changes-array).
8383

@@ -89,7 +89,7 @@ const changes = hfInstance.clearSheet(0);
8989
### Replacing sheet content
9090

9191
Instead of removing and adding the content of a sheet you can replace
92-
it right away. To do so use `setSheetContent`, in which you can pass
92+
it right away. To do so use [`setSheetContent`](../api/classes/hyperformula.md#setsheetcontent), in which you can pass
9393
the sheet ID and its new values.
9494
This method returns [an array of changed cells](#changes-array).
9595

@@ -102,7 +102,7 @@ const changes = hfInstance.setSheetContent(0, [['50'], ['60']]);
102102

103103
### Adding rows
104104

105-
You can add one or more rows by using the `addRows` method. The first
105+
You can add one or more rows by using the [`addRows`](../api/classes/hyperformula.md#addrows) method. The first
106106
parameter you need to pass is a sheet ID, and the second parameter
107107
represents the position and the size of a block of rows to be added.
108108
This method returns [an array of changed cells](#changes-array).
@@ -115,7 +115,7 @@ const changes = hfInstance.addRows(0, [0, 2]);
115115

116116
### Removing rows
117117

118-
You can remove one or more rows by using the `removeRows` method. The
118+
You can remove one or more rows by using the [`removeRows`](../api/classes/hyperformula.md#removerows) method. The
119119
first parameter you need to pass is a sheet ID, and the second
120120
parameter represents the position and the size of a block of rows to
121121
be removed.
@@ -129,7 +129,7 @@ const changes = hfInstance.removeRows(0, [0, 2]);
129129

130130
### Moving rows
131131

132-
You can move one or more rows by using the `moveRows` method. You need
132+
You can move one or more rows by using the [`moveRows`](../api/classes/hyperformula.md#moverows) method. You need
133133
to pass the following parameters:
134134

135135
* Sheet ID
@@ -147,7 +147,7 @@ const changes = hfInstance.moveRows(0, 0, 1, 2);
147147

148148
### Reordering rows
149149

150-
You can change the order of rows by using the `setRowOrder` method. You need to pass the following parameters:
150+
You can change the order of rows by using the [`setRowOrder`](../api/classes/hyperformula.md#setroworder) method. You need to pass the following parameters:
151151
* Sheet ID
152152
* New row order
153153

@@ -162,7 +162,7 @@ const changes = hfInstance.setRowOrder(0, [2, 1, 0]);
162162

163163
### Adding columns
164164

165-
You can add one or more columns by using the `addColumns` method.
165+
You can add one or more columns by using the [`addColumns`](../api/classes/hyperformula.md#addcolumns) method.
166166
The first parameter you need to pass is a sheet ID, and the second
167167
parameter represents the position and the size of a block of columns
168168
to be added.
@@ -176,7 +176,7 @@ const changes = hfInstance.addColumns(0, [0, 2]);
176176

177177
### Removing columns
178178

179-
You can remove one or more columns by using the `removeColumns` method.
179+
You can remove one or more columns by using the [`removeColumns`](../api/classes/hyperformula.md#removecolumns) method.
180180
The first parameter you need to pass is a sheet ID, and the second
181181
parameter represents the position and the size of a block of columns
182182
to be removed.
@@ -190,7 +190,7 @@ const changes = hfInstance.removeColumns(0, [0, 2]);
190190

191191
### Moving columns
192192

193-
You can move one or more columns by using the `moveColumns` method.
193+
You can move one or more columns by using the [`moveColumns`](../api/classes/hyperformula.md#movecolumns) method.
194194
You need to pass the following parameters:
195195

196196
* Sheet ID
@@ -202,13 +202,13 @@ This method returns [an array of changed cells](#changes-array).
202202

203203
```javascript
204204
// track the changes triggered by moving
205-
// the first column in the first sheet into column 2
205+
// the first column in the first sheet into column 2
206206
const changes = hfInstance.moveColumns(0, 0, 1, 2);
207207
```
208208

209209
### Reordering columns
210210

211-
You can change the order of columns by using the `setColumnOrder` method. You need to pass the following parameters:
211+
You can change the order of columns by using the [`setColumnOrder`](../api/classes/hyperformula.md#setcolumnorder) method. You need to pass the following parameters:
212212
* Sheet ID
213213
* New column order
214214

@@ -222,19 +222,19 @@ const changes = hfInstance.setColumnOrder(0, [2, 1, 0]);
222222
## Cells
223223

224224
::: tip
225-
By default, cells are identified using a `SimpleCellAddress` which
225+
By default, cells are identified using a [`SimpleCellAddress`](../api/interfaces/simplecelladdress) which
226226
consists of a sheet ID, column ID, and row ID, like this:
227227
`{ sheet: 0, col: 0, row: 0 }`
228228

229229
Alternatively, you can work with the **A1 notation** known from
230230
spreadsheets like Excel or Google Sheets. The API provides the helper
231-
function `simpleCellAddressFromString` which you can use to retrieve
232-
the `SimpleCellAddress` .
231+
function [`simpleCellAddressFromString`](../api/globals.md#simplecelladdressfromstring) which you can use to retrieve
232+
the [`SimpleCellAddress`](../api/interfaces/simplecelladdress) .
233233
:::
234234

235235
### Moving cells
236236

237-
You can move one or more cells using the `moveCells` method. You need
237+
You can move one or more cells using the [`moveCells`](../api/classes/hyperformula.md#movecells) method. You need
238238
to pass the following parameters:
239239

240240
* Source range ([SimpleCellRange](../api/interfaces/simplecellrange))
@@ -256,8 +256,8 @@ const changes = hfInstance.moveCells({ start: source, end: source }, destination
256256
### Updating cells
257257

258258
You can set the content of a block of cells by using the
259-
`setCellContents` method. You need to pass the top left corner address
260-
of a block as a simple cell address, along with the content to be set.
259+
[`setCellContents`](../api/classes/hyperformula.md#setcellcontents) method. You need to pass the top left corner address
260+
of a block as a [`SimpleCellAddress`](../api/interfaces/simplecelladdress), along with the content to be set.
261261
It can be content for either a single cell or a set of cells in an array.
262262
This method returns [an array of changed cells](#changes-array).
263263

@@ -269,8 +269,8 @@ const changes = hfInstance.setCellContents({ col: 3, row: 0, sheet: 0 }, [['=B1'
269269

270270
### Getting cell value
271271

272-
You can get the value of a cell by using `getCellValue` . Remember to
273-
pass the coordinates as a `SimpleCellAddress` .
272+
You can get the value of a cell by using [`getCellValue`](../api/classes/hyperformula.md#getcellvalue) . Remember to
273+
pass the coordinates as a [`SimpleCellAddress`](../api/interfaces/simplecelladdress) .
274274

275275
```javascript
276276
// get the value of the B1 cell
@@ -279,8 +279,8 @@ const B1Value = hfInstance.getCellValue({ sheet: 0, col: 1, row: 0 });
279279

280280
### Getting cell formula
281281

282-
You can retrieve the formula from a cell by using `getCellFormula`.
283-
Remember to pass the coordinates as a `SimpleCellAddress` .
282+
You can retrieve the formula from a cell by using [`getCellFormula`](../api/classes/hyperformula.md#getcellformula).
283+
Remember to pass the coordinates as a [`SimpleCellAddress`](../api/interfaces/simplecelladdress) .
284284

285285
```javascript
286286
// get the formula from the A1 cell
@@ -355,7 +355,7 @@ if (!isRemovable) {
355355

356356
## Changes array
357357

358-
All data modification methods return an array of `ExportedChange`.
358+
All data modification methods return an array of [`ExportedChange`](../api/globals.md#exportedchange).
359359
This is a collection of cells whose **values** were affected by an operation,
360360
together with their absolute addresses and new values.
361361

0 commit comments

Comments
 (0)