Function: renameWorksheet()

function renameWorksheet(
   workbook: Workbook, 
   identifier: string | number, 
   newName: string): void;

Defined in: src/excel/excel.tsx:423

Rename a worksheet.

Parameters

Parameter	Type	Description
workbook	Workbook	The ExcelJS workbook instance.
identifier	string | number	The worksheet index or name.
newName	string	The new name for the worksheet.

Returns

void

Example

renameWorksheet(workbook, 'Sheet1', 'Q4 Financials');
renameWorksheet(workbook, 0, 'Summary');