API: kyvos.viewer.openWorksheetRenameDialog

Applies to: Kyvos Enterprise Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)

This event requests Kyvos to open the worksheet Rename dialog.

Interface

{"msgId": "",
"msgName": "kyvos.viewer.openWorksheetRenameDialog", "payload": {
"worksheetId": "", "worksheetName": ""
}}

Kyvos will try to open the Rename dialog for the provided worksheetId or worksheetName. If both the attributes are provided, then the worksheetId is preferred over the worksheetName.
If the provided worksheetId or worksheetName is not found, then Kyvos will throw an error event.
Kyvos will try to open the Rename dialog for the currently opened worksheet if no worksheetId or worksheetName provided.