Skip to content

Commit 4a1ced5

Browse files
committed
Docs: Explain getSheetDimensions() issue with empty rows and columns
1 parent 245799c commit 4a1ced5

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/HyperFormula.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -887,6 +887,8 @@ export class HyperFormula implements TypedEmitter {
887887
* Returns dimensions of a specified sheet.
888888
* The sheet dimensions is represented with numbers: width and height.
889889
*
890+
* Note: Due to the memory optimizations, some of the empty bottom rows and rightmost columns are not counted to the dimensions.
891+
*
890892
* @param {number} sheetId - sheet ID number
891893
*
892894
* @throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type
@@ -1341,7 +1343,7 @@ export class HyperFormula implements TypedEmitter {
13411343
* Note: This method may trigger dependency graph recalculation.
13421344
*
13431345
* @param {number} sheetId - ID of a sheet to operate on
1344-
* @param {number[]} newRowOrder - permutation of rows
1346+
* @param {number[]} newRowOrder - permutation of rows; array length must match the number of rows returned by [getSheetDimensions()](#getsheetdimensions)
13451347
*
13461348
* @fires [[valuesUpdated]] if recalculation was triggered by this change
13471349
*
@@ -1506,7 +1508,7 @@ export class HyperFormula implements TypedEmitter {
15061508
* Note: This method may trigger dependency graph recalculation.
15071509
*
15081510
* @param {number} sheetId - ID of a sheet to operate on
1509-
* @param {number[]} newColumnOrder - permutation of columns
1511+
* @param {number[]} newColumnOrder - permutation of columns; array length must match the number of columns returned by [getSheetDimensions()](#getsheetdimensions)
15101512
*
15111513
* @fires [[valuesUpdated]] if recalculation was triggered by this change
15121514
*

0 commit comments

Comments
 (0)