Versions Compared

Version Old Version 2 New Version 3
Changes made by

Nidhi Bhandari (Unlicensed)

Sarabjeet Kaur

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This event requests Kyvos to delete an existing worksheet.

Interface

Code Block
{"msgId": "",
"msgName": "kyvos.viewer.deleteWorksheet", "payload": {
"workSheetId": "",
"workSheetName": "", "showConfirmation": true
}}

Points to consider

  1. Kyvos will delete the worksheet with the provided details i.e. either worksheetId or worksheetName should exist in currently opened workbook.
  2. The possible values for showConfirmation are true or false. If it is set as true, then a confirmation box will be displayed before deleting the worksheet. If the value is set as false, Kyvos will delete the worksheet directly.
  3. If no worksheetId or worksheetName is provided, then the currently opened worksheet is deleted.

Example

Code Block
{"msgId": "16913393120795127065078125396110",
"msgName": "kyvos.viewer.deleteWorksheet", "payload": {
"workSheetId": "Sheet16913391345058127065016175385373",
"workSheetName": "", "showConfirmation": true
}}