Skip to content
Mog is in active development. The GitHub repo, SDK packages, and community channels are not yet available. Follow for launch updates

wb.sheets

WorkbookSheets

10 methods

add

Promise<Worksheet>
add(name?: string, index?: number): Promise<Worksheet>;
ParameterTypeRequired
namestringoptional
indexnumberoptional

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>;
ParameterTypeRequired
targetnumber | stringrequired

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>;
ParameterTypeRequired
namestringrequired
toIndexnumberrequired

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>;
ParameterTypeRequired
targetnumber | stringrequired
newNamestringrequired

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>;
ParameterTypeRequired
targetnumber | stringrequired

Set the active sheet. @param target - 0-based index or sheet name.

copy

Promise<Worksheet>
copy(source: number | string, newName?: string): Promise<Worksheet>;
ParameterTypeRequired
sourcenumber | stringrequired
newNamestringoptional

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>;
ParameterTypeRequired
targetnumber | stringrequired

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>;
ParameterTypeRequired
targetnumber | stringrequired

Show (unhide) a sheet. @param target - 0-based index or sheet name.

setSelectedIds

Promise<void>
setSelectedIds(sheetIds: string[]): Promise<void>;
ParameterTypeRequired
sheetIdsstring[]required

Set which sheets are selected (multi-sheet selection for collaboration). @param sheetIds - Array of sheet IDs to mark as selected.

on

() => void
on(
    event: 'sheetAdded' | 'sheetRemoved' | 'sheetRenamed' | 'activeSheetChanged',
    handler: (event: any) => void,
  ): () => void;
ParameterTypeRequired
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