Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Explain getSheetDimensions() issue with empty rows and columns #1476

Merged
merged 1 commit into from
Dec 21, 2024
Merged

Docs: Explain getSheetDimensions() issue with empty rows and columns #1476

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/HyperFormula.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -887,6 +887,8 @@ export class HyperFormula implements TypedEmitter {
* Returns dimensions of a specified sheet.
* The sheet dimensions is represented with numbers: width and height.
*
* Note: Due to the memory optimizations, some of the empty bottom rows and rightmost columns are not counted to the dimensions.
*
* @param {number} sheetId - sheet ID number
*
* @throws [[ExpectedValueOfTypeError]] if any of its basic type argument is of wrong type
Expand Down Expand Up @@ -1341,7 +1343,7 @@ export class HyperFormula implements TypedEmitter {
* Note: This method may trigger dependency graph recalculation.
*
* @param {number} sheetId - ID of a sheet to operate on
* @param {number[]} newRowOrder - permutation of rows
* @param {number[]} newRowOrder - permutation of rows; array length must match the number of rows returned by [getSheetDimensions()](#getsheetdimensions)
*
* @fires [[valuesUpdated]] if recalculation was triggered by this change
*
Expand Down Expand Up @@ -1506,7 +1508,7 @@ export class HyperFormula implements TypedEmitter {
* Note: This method may trigger dependency graph recalculation.
*
* @param {number} sheetId - ID of a sheet to operate on
* @param {number[]} newColumnOrder - permutation of columns
* @param {number[]} newColumnOrder - permutation of columns; array length must match the number of columns returned by [getSheetDimensions()](#getsheetdimensions)
*
* @fires [[valuesUpdated]] if recalculation was triggered by this change
*
Expand Down
Loading