DeleteRow Method

Deletes a row within a Google Worksheet.

Syntax

gspreadsheets.deleteRow([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The component will delete the row, specified by RowIndex, within the worksheet specified by WorksheetIndex.

Prior to calling DeleteRow, you must specify a RowETag value so that an "If-Match" header is sent (note this property is set automatically when RowIndex is set). To ensure that you do not delete a row that has been changed, set RowETag to the row's ETag value. Setting RowETag to "*", will delete the row regardless of whether it has been updated or not.

Note when a row is deleted, it is completely removed from the worksheet.