Skip to content

Commit

Permalink
Don't mention 3D references in the docs (#1338)
Browse files Browse the repository at this point in the history
Don't mention 3D references in the docs. In some cases they work but we don't officially support them.
  • Loading branch information
sequba authored Dec 13, 2023
1 parent ff436f0 commit 4230e82
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 21 deletions.
15 changes: 7 additions & 8 deletions docs/guide/cell-references.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ different cells in the workbook.

### Referring to named expressions

This is a special case in HyperFormula. Upon creation you define the
This is a special case in HyperFormula. Upon creation, you define the
scope of the expression:

```javascript
Expand Down Expand Up @@ -166,28 +166,27 @@ In HyperFormula, a range is a reference to a group of at least two adjacent cell

### Range definition

Range `<Cell address 1>:<Cell address 2>` is a reference to the smallest possible group of adjacent cells that includes:
Range `<Cell address 1>:<Cell address 2>` is a reference to the smallest rectangular group of adjacent cells that includes:

- The cell at `<Cell address 1>`
- The cell at `<Cell address 2>`
- If referencing across different sheets (so-called 3D reference): all cells on all sheets between `<Cell address 1>` and `<Cell address 2>`

### Range types

HyperFormula features the following types of ranges:

| Range type | Description | Example |
| ------------ | ----------------------------------- | --------------------------------------------- |
|--------------|-------------------------------------|-----------------------------------------------|
| Cell range | Has the shape of a finite rectangle | =A1:B2<br>or =A2:B1<br>or =B1:A2<br>or =B2:A1 |
| Column range | Contains entire columns | =A:B<br>or =B:A |
| Row range | Contains entire rows | =1:2<br>or =2:1 |

### Referencing ranges

You can reference ranges:
- Through relative references (=A1:B2)
- Through absolute references (=A$1:$B$2)
- Across different sheets (=Sheet1!A1:Sheet5!B2)<br>If you don't specify a sheet name for the second cell address, the sheet name of the first cell address is used: `=Sheet5!A1:B2` is equivalent to `=Sheet5!A1:Sheet5!B2`.
- Through a relative reference, e.g. `=A1:B2`
- Through an absolute reference, e.g. `=A$1:$B$2`
- Through a reference with an explicit sheet address, e.g. `=Sheet5!A1:B2`

### Range restraints

Expand Down Expand Up @@ -228,7 +227,7 @@ used in a cell.
Consider the following example:

| Formula in C1 | Action | Result in B1 |
| :------------ | :-------------- | :----------- |
|:--------------|:----------------|:-------------|
| =A1+B1+20 | Delete column A | #REF! |

The #REF! error may also occur in other specific situations:
Expand Down
26 changes: 13 additions & 13 deletions docs/guide/named-expressions.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ follows:
| Type | Custom name | Example expression |
|:------------------------|:------------|:--------------------------|
| Named cell | myCell | =Sheet1!$A$1 |
| Named range of cells | myRange | =Sheet1!$A$1:Sheet1!$D$10 |
| Named range of cells | myRange | =Sheet1!$A$1:$D$10 |
| Named constant (number) | myNumber | =10 |
| Named constant (string) | myText | ="One Small Step for Man" |
| Named formula | myFormula | =SUM(Sheet1!$A$1:$D$10) |
Expand Down Expand Up @@ -59,19 +59,19 @@ hfInstance.addNamedExpression('MyRevenue', '=Sheet2!$A$1+100', 1);

For examples of valid and invalid expression names, see the following table:

| Name | Validity |
| :----------- | :------- |
| my Revenue | Invalid |
| myRevenue | Valid |
| quarter1 | Invalid |
| quarter_1 | Valid |
| 1stQuarter | Invalid |
| Name | Validity |
|:------------|:---------|
| my Revenue | Invalid |
| myRevenue | Valid |
| quarter1 | Invalid |
| quarter_1 | Valid |
| 1stQuarter | Invalid |
| _1stQuarter | Valid |
| .NET | Invalid |
| ASP.NET | Valid |
| A1 | Invalid |
| $A$1 | Invalid |
| RC | Invalid |
| .NET | Invalid |
| ASP.NET | Valid |
| A1 | Invalid |
| $A$1 | Invalid |
| RC | Invalid |

## Available methods

Expand Down

0 comments on commit 4230e82

Please sign in to comment.