Event: kyvos.viewer.onWorksheetRenameComplete

Event: kyvos.viewer.onWorksheetRenameComplete

This documentation is for Kyvos 2026.2.x. To view documentation for other Kyvos versions, click here.

This documentation is for Kyvos 2026.2.x. To view documentation for other Kyvos versions, click here.

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 will be triggered when a user clicks the Save button on the Rename dialog.

Interface

{"msgId": "", "msgName": "kyvos.viewer.onWorksheetRenameComplete","payload": { "info": { "status": "success", "desc": "Rename successfully." }, "data": { "worksheetId": "", "worksheetPrevName": "", "worksheetNewName": "" } } }}

Points to consider

  1. In payload, the Host App will get worksheetPrevName, worksheetNewName, and worksheetId.

Example

{"msgId": "16902274687317127070085178274360", "msgName": "kyvos.viewer.onWorksheetRenameComplete", "payload": { "info": { "status": "success", "desc": "Worksheet renamed successfully.", "extDesc": "", "code": 0 }, "data": { "workSheetId": "16893155276982127060072136667969", "workSheetPrevName": "Sheet 1 copy 2", "workSheetNewName": "Sheet 2" } }}



Copyright Kyvos, Inc. 2026. All rights reserved.