merge/unmerge docs

theoephraim · Nov 27, 2020 · a7aabfe · a7aabfe
1 parent c19da2b
commit a7aabfe
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/docs/classes/google-spreadsheet-worksheet.md b/docs/classes/google-spreadsheet-worksheet.md
@@ -194,7 +194,22 @@ Param|Type|Required|Description
 
 - ✨ **Side effects** - cache is emptied so props and cells must be re-fetched
 
+#### `mergeCells(range, mergeType)` (async) :id=fn-mergeCells
+> merge cells together
 
+Param|Type|Required|Description
+---|---|---|---
+`range`|[[GridRange](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/other#GridRange)]|✅|Range of cells to merge, sheetId not required!
+`mergeType`|String (enum)<br>[MergeType](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#MergeType|-|defaults to MERGE_ALL
+
+- 🚨 **Warning** - Reading values from merged cells other than the top-left one will show a null value
+
+#### `unmergeCells(range)` (async) :id=fn-unmergeCells
+> split merged cells
+
+Param|Type|Required|Description
+---|---|---|---
+`range`|[[GridRange](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/other#GridRange)]|✅|Range of cells to unmerge, sheetId not required!
 
 ### Updating Sheet Properties
 

diff --git a/lib/GoogleSpreadsheetWorksheet.js b/lib/GoogleSpreadsheetWorksheet.js
@@ -556,6 +556,9 @@ class GoogleSpreadsheetWorksheet {
   async mergeCells(range, mergeType = 'MERGE_ALL') {
     // Request type = `mergeCells`
     // https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#MergeCellsRequest
+    if (range.sheetId !== this.sheetId) {
+      throw new Error('Leave sheet ID blank or set to matching ID of this sheet');
+    }
     await this._makeSingleUpdateRequest('mergeCells', {
       mergeType,
       range: {
@@ -568,6 +571,9 @@ class GoogleSpreadsheetWorksheet {
   async unmergeCells(range) {
     // Request type = `unmergeCells`
     // https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#UnmergeCellsRequest
+    if (range.sheetId !== this.sheetId) {
+      throw new Error('Leave sheet ID blank or set to matching ID of this sheet');
+    }
     await this._makeSingleUpdateRequest('unmergeCells', {
       range: {
         ...range,