Workbook

create(name: string, rows: number, columns: number, options?: { index?: number; sheet?: Partial<IWorksheetData> }): FWorksheet

createRangeThemeStyle(themeName: string, themeStyleJson?: Omit<IRangeThemeStyleJSON, 'name'>): RangeThemeStyle

const fWorkbook = univerAPI.getActiveWorkbook();const rangeThemeStyle = fWorkbook.createRangeThemeStyle('MyTheme', {  secondRowStyle: {    bg: {      rgb: 'rgb(214,231,241)',    },  },});console.log(rangeThemeStyle);

deleteActiveSheet(): boolean

const fWorkbook = univerAPI.getActiveWorkbook();fWorkbook.deleteActiveSheet();

deleteDefinedName(name: string): boolean

// The code below deletes the defined name with the given nameconst fWorkbook = univerAPI.getActiveWorkbook();fWorkbook.deleteDefinedName('MyDefinedName');

deleteSheet(sheet: FWorksheet | string): boolean

// The code below deletes the specified worksheetconst fWorkbook = univerAPI.getActiveWorkbook();const sheet = fWorkbook.getSheets()[1];fWorkbook.deleteSheet(sheet);// The code below deletes the specified worksheet by id// fWorkbook.deleteSheet(sheet.getSheetId());

getActiveSheet(): FWorksheet

// The code below gets the active sheet of the workbookconst fWorkbook = univerAPI.getActiveWorkbook();const fWorksheet = fWorkbook.getActiveSheet();console.log(fWorksheet);

getSheetByName(name: string): FWorksheet | null

// The code below gets a worksheet by sheet nameconst fWorkbook = univerAPI.getActiveWorkbook();const sheet = fWorkbook.getSheetByName('Sheet1');console.log(sheet);

getSheetBySheetId(sheetId: string): FWorksheet | null

// The code below gets a worksheet by sheet idconst fWorkbook = univerAPI.getActiveWorkbook();const sheet = fWorkbook.getSheetBySheetId('sheetId');console.log(sheet);

getSheets(): FWorksheet[]

// The code below gets all the worksheets in the workbookconst fWorkbook = univerAPI.getActiveWorkbook();const sheets = fWorkbook.getSheets();console.log(sheets);

insertDefinedName(name: string, formulaOrRefString: string): FWorkbook

// The code below inserts a defined nameconst fWorkbook = univerAPI.getActiveWorkbook();fWorkbook.insertDefinedName('MyDefinedName', 'Sheet1!$A$1');

insertDefinedNameBuilder(param: ISetDefinedNameMutationParam): void

// The code below inserts a defined name by builder paramconst fWorkbook = univerAPI.getActiveWorkbook();const definedNameParam = fWorkbook.newDefinedNameBuilder()  .setRef('Sheet1!$A$1')  .setName('MyDefinedName')  .setComment('This is a comment')  .build();fWorkbook.insertDefinedNameBuilder(definedNameParam);

newDefinedNameBuilder(): FDefinedNameBuilder

const fWorkbook = univerAPI.getActiveWorkbook();const definedNameParam = fWorkbook.newDefinedNameBuilder()  .setRef('Sheet1!$A$1')  .setName('MyDefinedName')  .setComment('This is a comment')  .build();console.log(definedNameParam);fWorkbook.insertDefinedNameBuilder(definedNameParam);

insertSheet(sheetName?: string, options?: { index?: number; sheet?: Partial<IWorksheetData> }): FWorksheet

getDefinedName(name: string): FDefinedName | null

// The code below gets the defined name by nameconst fWorkbook = univerAPI.getActiveWorkbook();const definedName = fWorkbook.getDefinedName('MyDefinedName');console.log(definedName?.getFormulaOrRefString());

getDefinedNames(): FDefinedName[]

// The code below gets all the defined names in the workbookconst fWorkbook = univerAPI.getActiveWorkbook();const definedNames = fWorkbook.getDefinedNames();console.log(definedNames, definedNames[0]?.getFormulaOrRefString());

getName(): string

// The code below gets the name of the workbookconst fWorkbook = univerAPI.getActiveWorkbook();const name = fWorkbook.getName();console.log(name);

getTableInfoByName(tableName: string): ITableInfoWithUnitId | undefined

setName(name: string): this

// The code below sets the name of the workbookconst fWorkbook = univerAPI.getActiveWorkbook();fWorkbook.setName('MyWorkbook');

updateDefinedNameBuilder(param: ISetDefinedNameMutationParam): void

// The code below updates the defined name with the given nameconst fWorkbook = univerAPI.getActiveWorkbook();const definedName = fWorkbook.getDefinedName('MyDefinedName');console.log(definedName?.getFormulaOrRefString());// Update the defined nameif (definedName) {  const newDefinedNameParam = definedName.toBuilder()    .setName('NewDefinedName')    .setRef('Sheet1!$A$2')    .build();  fWorkbook.updateDefinedNameBuilder(newDefinedNameParam);}

getRegisteredRangeThemes(): string[]

// The code below gets the registered range themesconst fWorkbook = univerAPI.getActiveWorkbook();const themes = fWorkbook.getRegisteredRangeThemes();console.log(themes);

registerRangeTheme(rangeThemeStyle: RangeThemeStyle): void

const fWorkbook = univerAPI.getActiveWorkbook();const rangeThemeStyle = fWorkbook.createRangeThemeStyle('MyTheme', {  secondRowStyle: {    bg: {      rgb: 'rgb(214,231,241)',    },  },});fWorkbook.registerRangeTheme(rangeThemeStyle);

unregisterRangeTheme(themeName: string): void

const fWorkbook = univerAPI.getActiveWorkbook();fWorkbook.unregisterRangeTheme('MyTheme');

getPreprocessRanges(responseDataMode?: string): Record<string, ITableJson[]>

const fWorkbook = univerAPI.getActiveWorkbook()const preprocessRanges = fWorkbook.getPreprocessRanges()

getSnapshot(): IWorkbookData

// The code below saves the workbook snapshot dataconst activeSpreadsheet = univerAPI.getActiveWorkbook();const snapshot = activeSpreadsheet.getSnapshot();

async addPivotTable(sourceInfo: IUnitRangeName & { subUnitId: string }, positionType: PositionType, anchorCellInfo: IPivotCellPositionInfo): Promise<FPivotTable | undefined>

getPivotTableByCell(unitId: string, subUnitId: string, row: number, col: number): FPivotTable | undefined

getPivotTableById(pivotTableId: string): FPivotTable | undefined

abortEditingAsync(): Promise<boolean>

addStyles(styles: Record<string, IStyleData>): void

clearComments(): Promise<boolean>

customizeColumnHeader(cfg: IColumnsHeaderCfgParam): void

customizeRowHeader(cfg: IRowsHeaderCfgParam): void

disableSelection(): FWorkbook

dispose(): void

duplicateActiveSheet(): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook();const duplicatedSheet = fWorkbook.duplicateActiveSheet();console.log(duplicatedSheet);

duplicateSheet(sheet: FWorksheet): FWorksheet

// The code below duplicates the given worksheetconst fWorkbook = univerAPI.getActiveWorkbook();const activeSheet = fWorkbook.getActiveSheet();const duplicatedSheet = fWorkbook.duplicateSheet(activeSheet);console.log(duplicatedSheet);

enableSelection(): FWorkbook

async endEditing(save?: boolean): Promise<boolean>

endEditingAsync(save = true): Promise<boolean>

getActiveCell(): FRange | null

const fWorkbook = univerAPI.getActiveWorkbook();console.log(fWorkbook.getActiveCell().getA1Notation());

getActiveRange(): FRange | null

const fWorkbook = univerAPI.getActiveWorkbook();const activeRange = fWorkbook.getActiveRange();console.log(activeRange);

async getAllDataValidationErrorAsync(): Promise<IDataValidationError[]>

getAllFormulaError(): ISheetFormulaError[]

getComments(): FThreadComment[]

getCustomMetadata(): CustomData | undefined

const fWorkbook = univerAPI.getActiveWorkbook();const custom = fWorkbook.getCustomMetadata();console.log(custom);

getId(): string

// The code below gets the id of the workbookconst fWorkbook = univerAPI.getActiveWorkbook();const unitId = fWorkbook.getId();console.log(unitId);

getLocale(): LocaleType

// The code below gets the locale of the workbookconst fWorkbook = univerAPI.getActiveWorkbook();console.log(fWorkbook.getLocale());

getNumSheets(): number

// The code below gets the number of sheets in the workbookconst fWorkbook = univerAPI.getActiveWorkbook();console.log(fWorkbook.getNumSheets());

getScrollStateBySheetId(sheetId: string): Nullable<IScrollState>

 tsuniverAPI.getActiveWorkbook().getScrollStateBySheetId($sheetId)

getUrl(): string

// The code below gets the URL of the workbookconst fWorkbook = univerAPI.getActiveWorkbook();const url = fWorkbook.getUrl();console.log(url);

getValidatorStatus(): Promise<Record<string, ObjectMatrix<Nullable<DataValidationStatus>>>>

getWorkbook(): Workbook

// The code below gets the Workbook instanceconst fWorkbook = univerAPI.getActiveWorkbook();const workbook = fWorkbook.getWorkbook();console.log(workbook);

getWorkbookPermission(): FWorkbookPermission

const fWorkbook = univerAPI.getActiveWorkbook();const permission = fWorkbook.getWorkbookPermission();// Set workbook to read-only modeawait permission.setMode('viewer');// Add a collaboratorawait permission.addCollaborator({  userId: 'user123',  name: 'John Doe',  role: 'editor'});// Subscribe to permission changespermission.permission$.subscribe(snapshot => {  console.log('Permissions changed:', snapshot);});

id: string

isCellEditing(): boolean

moveActiveSheet(index: number): FWorkbook

// The code below moves the active sheet to the specified indexconst fWorkbook = univerAPI.getActiveWorkbook();fWorkbook.moveActiveSheet(1);

moveSheet(sheet: FWorksheet, index: number): FWorkbook

// The code below moves the sheet to the specified indexconst fWorkbook = univerAPI.getActiveWorkbook();const sheet = fWorkbook.getActiveSheet();fWorkbook.moveSheet(sheet, 1);

navigateToSheetHyperlink(hyperlink: string): void

const fWorkbook = univerAPI.getActiveWorkbook();fWorkbook.navigateToSheetHyperlink('#gid=sheet1&range=A1');

onBeforeAddDataValidation(callback: (params: IAddSheetDataValidationCommandParams, options: IExecutionOptions | undefined) => void | false): IDisposable

onBeforeCommandExecute(callback: CommandListener): IDisposable

onBeforeDeleteAllDataValidation(callback: (params: IRemoveSheetAllDataValidationCommandParams, options: IExecutionOptions | undefined) => void | false): IDisposable

onBeforeDeleteDataValidation(callback: (params: IRemoveSheetDataValidationCommandParams, options: IExecutionOptions | undefined) => void | false): IDisposable

onBeforeUpdateDataValidationCriteria(callback: (params: IUpdateSheetDataValidationSettingCommandParams, options: IExecutionOptions | undefined) => void | false): IDisposable

onBeforeUpdateDataValidationOptions(callback: (params: IUpdateSheetDataValidationOptionsCommandParams, options: IExecutionOptions | undefined) => void | false): IDisposable

onBeforeUpdateDataValidationRange(callback: (params: IUpdateSheetDataValidationRangeCommandParams, options: IExecutionOptions | undefined) => void | false): IDisposable

onCellClick(callback: (cell: IHoverRichTextInfo) => void): IDisposable

onCellHover(callback: (cell: IHoverRichTextPosition) => void): IDisposable

onCellPointerDown(callback: (cell: ICellPosWithEvent) => void): IDisposable

onCellPointerMove(callback: (cell: ICellPosWithEvent, event: IPointerEvent | IMouseEvent) => void): IDisposable

onCellPointerUp(callback: (cell: ICellPosWithEvent) => void): IDisposable

onCommandExecuted(callback: CommandListener): IDisposable

onDragOver(callback: (cell: IDragCellPosition) => void): IDisposable

onDrop(callback: (cell: IDragCellPosition) => void): IDisposable

onSelectionChange(callback: (selections: IRange[]) => void): IDisposable

parseSheetHyperlink(hyperlink: string): ISheetHyperLinkInfo

const fWorkbook = univerAPI.getActiveWorkbook();const info = fWorkbook.parseSheetHyperlink('#gid=sheet1&range=A1');console.log(info);

getUrlOfDefineName(name: string): string

redo(): FWorkbook

// The code below redoes the last undone actionconst fWorkbook = univerAPI.getActiveWorkbook();fWorkbook.redo();

removeStyles(styleKeys: string[]): void

save(): IWorkbookData

// The code below saves the workbook snapshot dataconst fWorkbook = univerAPI.getActiveWorkbook();const snapshot = fWorkbook.save();console.log(snapshot);

async saveScreenshotToClipboard(): Promise<boolean>

setActiveRange(range: FRange): FWorkbook

const fWorkbook = univerAPI.getActiveWorkbook();const range = fWorkbook.getActiveSheet().getRange('A10:B10');fWorkbook.setActiveRange(range);

setActiveSheet(sheet: FWorksheet | string): FWorksheet

// The code below sets the given worksheet to be the active worksheetconst fWorkbook = univerAPI.getActiveWorkbook();const sheet = fWorkbook.getSheets()[1];fWorkbook.setActiveSheet(sheet);

setCustomMetadata(custom: CustomData | undefined): FWorkbook

const fWorkbook = univerAPI.getActiveWorkbook();fWorkbook.setCustomMetadata({ key: 'value' });

setLocale(locale: LocaleType): void

setNumfmtLocal(locale: INumfmtLocaleTag): FWorkbook

const fWorkbook = univerAPI.getActiveWorkbook();fWorkbook.setNumfmtLocal('de_DE');

setPermissionDialogVisible(visible: boolean): void

setSpreadsheetLocale(locale: LocaleType): FWorkbook

// The code below sets the locale of the workbookconst fWorkbook = univerAPI.getActiveWorkbook();fWorkbook.setSpreadsheetLocale(univerAPI.Enum.LocaleType.EN_US);console.log(fWorkbook.getLocale());

showSelection(): FWorkbook

startEditing(): boolean

transparentSelection(): FWorkbook

undo(): FWorkbook

// The code below undoes the last actionconst fWorkbook = univerAPI.getActiveWorkbook();fWorkbook.undo();

closePrintDialog(): void

openPrintDialog(): void

print(): void

updatePrintConfig(config: ISheetPrintLayoutConfig): FWorkbook

updatePrintRenderConfig(config: ISheetPrintRenderConfig): FWorkbook

async addTable(subUnitId: string, tableName: string, rangeInfo: ITableRange, tableId?: string, options?: ITableOptions): Promise<string | undefined>

getTableInfo(tableId: string): ITableInfoWithUnitId | undefined

getTableList(): ITableInfoWithUnitId[]

async removeTable(tableId: string): Promise<boolean>

setEditable(value: boolean): FWorkbook

// The code below sets the editing permissions of the workbookconst fWorkbook = univerAPI.getActiveWorkbook();fWorkbook.setEditable(false);

setTableFilter(tableId: string, column: number, filter: ITableFilterItem | undefined): Promise<boolean>