DeleteWorksheet Method

Deletes a worksheet within a Google Worksheets feed.

Syntax

gspreadsheets.deleteWorksheet([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 worksheet, of a Google Worksheets feed, specified by WorksheetIndex.

Note when a worksheet is deleted, it is completely removed from the spreadsheet and all the contained data will be discarded.