Appearance
Function: deleteWorksheet()
ts
function deleteWorksheet(workbook: Workbook, identifier: string | number | RegExp): void;Defined in: src/excel/excel.tsx:479
Delete one or more worksheets by index, name, or RegExp pattern. When a RegExp is provided, all matching worksheets are removed.
Parameters
| Parameter | Type | Description |
|---|---|---|
workbook | Workbook | The ExcelJS workbook instance. |
identifier | string | number | RegExp | A zero-based index, sheet name, or RegExp pattern. |
Returns
void
Example
ts
deleteWorksheet(workbook, 'Old Report');
deleteWorksheet(workbook, 2);
deleteWorksheet(workbook, /^Temp/);