wb.sheets
WorkbookSheets
10 methods
add
→ Promise<Worksheet>add(name?: string, index?: number): Promise<Worksheet>;| Parameter | Type | Required |
|---|---|---|
| name | string | optional |
| index | number | optional |
Add a new sheet to the workbook. @param name - Optional sheet name. Defaults to "SheetN". @param index - Optional 0-based position to insert the sheet. @returns The created Worksheet.
remove
→ Promise<SheetRemoveReceipt>remove(target: number | string): Promise<SheetRemoveReceipt>;| Parameter | Type | Required |
|---|---|---|
| target | number | string | required |
Remove a sheet by index or name. Throws if attempting to remove the last sheet. @param target - 0-based index or sheet name.
move
→ Promise<SheetMoveReceipt>move(name: string, toIndex: number): Promise<SheetMoveReceipt>;| Parameter | Type | Required |
|---|---|---|
| name | string | required |
| toIndex | number | required |
Move a sheet to a new position. @param name - Sheet name (or identifier) to move. @param toIndex - Target 0-based index.
rename
→ Promise<SheetRenameReceipt>rename(target: number | string, newName: string): Promise<SheetRenameReceipt>;| Parameter | Type | Required |
|---|---|---|
| target | number | string | required |
| newName | string | required |
Rename a sheet. @param target - 0-based index or current sheet name. @param newName - The new name for the sheet.
setActive
→ void | Promise<void>setActive(target: number | string): void | Promise<void>;| Parameter | Type | Required |
|---|---|---|
| target | number | string | required |
Set the active sheet. @param target - 0-based index or sheet name.
copy
→ Promise<Worksheet>copy(source: number | string, newName?: string): Promise<Worksheet>;| Parameter | Type | Required |
|---|---|---|
| source | number | string | required |
| newName | string | optional |
Copy a sheet within the workbook. @param source - 0-based index or name of the sheet to copy. @param newName - Optional name for the copy. Defaults to "SheetName (Copy)". @returns The newly created Worksheet.
hide
→ Promise<SheetHideReceipt>hide(target: number | string): Promise<SheetHideReceipt>;| Parameter | Type | Required |
|---|---|---|
| target | number | string | required |
Hide a sheet. Throws if attempting to hide the last visible sheet. @param target - 0-based index or sheet name.
show
→ Promise<SheetShowReceipt>show(target: number | string): Promise<SheetShowReceipt>;| Parameter | Type | Required |
|---|---|---|
| target | number | string | required |
Show (unhide) a sheet. @param target - 0-based index or sheet name.
setSelectedIds
→ Promise<void>setSelectedIds(sheetIds: string[]): Promise<void>;| Parameter | Type | Required |
|---|---|---|
| sheetIds | string[] | required |
Set which sheets are selected (multi-sheet selection for collaboration). @param sheetIds - Array of sheet IDs to mark as selected.
on
→ () => voidon(
event: 'sheetAdded' | 'sheetRemoved' | 'sheetRenamed' | 'activeSheetChanged',
handler: (event: any) => void,
): () => void;| Parameter | Type | Required |
|---|---|---|
| event | 'sheetAdded' | 'sheetRemoved' | 'sheetRenamed' | 'activeSheetChanged' | required |
| handler | (event: any) => void, | required |
Subscribe to sheet collection events. Fires for: sheetAdded, sheetRemoved, sheetRenamed, activeSheetChanged. @param event - Event type @param handler - Event handler @returns Unsubscribe function