Workbook

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

const fWorkbook = univerAPI.getActiveWorkbook();

// Create a new sheet named 'MyNewSheet' with 10 rows and 10 columns
const newSheet = fWorkbook.create('MyNewSheet', 10, 10);
console.log(newSheet);

// Create a new sheet named 'MyNewSheetWithData' with 10 rows and 10 columns and some data, and set it as the first sheet
const sheetData = {
  // ... Omit other properties
  cellData: {
    0: {
      0: {
        v: 'Hello Univer!',
      }
    }
  },
  // ... Omit other properties
};
const newSheetWithData = fWorkbook.create('MyNewSheetWithData', 10, 10, {
  index: 0,
  sheet: sheetData,
});
console.log(newSheetWithData);

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 name
const fWorkbook = univerAPI.getActiveWorkbook();
fWorkbook.deleteDefinedName('MyDefinedName');

deleteSheet(sheet: FWorksheet | string): boolean

// The code below deletes the specified worksheet
const 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 workbook
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
console.log(fWorksheet);

getSheetByName(name: string): FWorksheet | null

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

getSheetBySheetId(sheetId: string): FWorksheet | null

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

getSheets(): FWorksheet[]

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

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

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

insertDefinedNameBuilder(param: ISetDefinedNameMutationParam): void

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

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

const fWorkbook = univerAPI.getActiveWorkbook();

// Create a new sheet with default configuration
const newSheet = fWorkbook.insertSheet();
console.log(newSheet);

// Create a new sheet with custom name and default configuration
const newSheetWithName = fWorkbook.insertSheet('MyNewSheet');
console.log(newSheetWithName);

// Create a new sheet with custom name and custom configuration
const sheetData = {
  // ... Omit other properties
  cellData: {
    0: {
      0: {
        v: 'Hello Univer!',
      }
    }
  },
  // ... Omit other properties
};
const newSheetWithData = fWorkbook.insertSheet('MyNewSheetWithData', {
  index: 0,
  sheet: sheetData,
});
console.log(newSheetWithData);

getDefinedName(name: string): FDefinedName | null

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

if (definedName) {
  definedName.setName('NewDefinedName');
}

getDefinedNames(): FDefinedName[]

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

getName(): string

// The code below gets the name of the workbook
const 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 workbook
const fWorkbook = univerAPI.getActiveWorkbook();
fWorkbook.setName('MyWorkbook');

updateDefinedNameBuilder(param: ISetDefinedNameMutationParam): void

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

// Update the defined name
if (definedName) {
  const newDefinedNameParam = definedName.toBuilder()
    .setName('NewDefinedName')
    .setRef('Sheet1!$A$2')
    .build();
  fWorkbook.updateDefinedNameBuilder(newDefinedNameParam);
}

getRegisteredRangeThemes(): string[]

// The code below gets the registered range themes
const 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');

getSnapshot(): IWorkbookData

// The code below saves the workbook snapshot data
const 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

const fWorkbook = univerAPI.getActiveWorkbook();

// Add styles to the workbook styles
const styles = {
  'custom-style-1': {
    bg: {
      rgb: 'rgb(255, 0, 0)',
    }
  },
  'custom-style-2': {
    fs: 20,
    n: {
      pattern: '@'
    }
  }
};
fWorkbook.addStyles(styles);

// Set values with the new styles
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:B2');
fRange.setValues([
  [{ v: 'Hello', s: 'custom-style-1' }, { v: 'Univer', s: 'custom-style-1' }],
  [{ v: 'To', s: 'custom-style-1' }, { v: '0001', s: 'custom-style-2' }],
]);

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 worksheet
const 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>

endZenEditingAsync(save = true): Promise<boolean>

async flushToFile(): Promise<void>

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 workbook
const fWorkbook = univerAPI.getActiveWorkbook();
const unitId = fWorkbook.getId();
console.log(unitId);

async getLintErrors(): Promise<ILintErrorReport>

getLocale(): LocaleType

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

getNumSheets(): number

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

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

getScrollStateBySheetId(sheetId: string): Nullable<IScrollState>

 ts
univerAPI.getActiveWorkbook().getScrollStateBySheetId($sheetId)

getUrl(): string

// The code below gets the URL of the workbook
const 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 instance
const 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 mode
await permission.setMode('viewer');

// Add a collaborator
await permission.addCollaborator({
  userId: 'user123',
  name: 'John Doe',
  role: 'editor'
});

// Subscribe to permission changes
permission.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 index
const fWorkbook = univerAPI.getActiveWorkbook();
fWorkbook.moveActiveSheet(1);

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

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

navigateToSheetHyperlink(hyperlink: string): void

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

onBeforeAddThreadComment(callback: (params: IAddCommentCommandParams, 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

onBeforeDeleteThreadComment(callback: (params: IDeleteCommentCommandParams, 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

onBeforeUpdateThreadComment(callback: (params: IUpdateCommandParams, 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

onDataValidationChange(callback: (ruleChange: IRuleChange) => void): IDisposable

onDataValidationStatusChange(callback: (statusChange: IValidStatusChange) => void): IDisposable

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

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

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

onThreadCommentChange(callback: (commentUpdate: CommentUpdate) => void | false): IDisposable

openDialog(dialog: IDialogPartMethodOptions): IDisposable

openSiderbar(params: ISidebarMethodOptions): IDisposable

parseSheetHyperlink(hyperlink: string): ISheetHyperLinkInfo

redo(): FWorkbook

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

removeStyles(styleKeys: string[]): void

const fWorkbook = univerAPI.getActiveWorkbook();

// Add styles to the workbook styles
const styles = {
  'custom-style-1': {
    bg: {
      rgb: 'rgb(255, 0, 0)',
    }
  },
  'custom-style-2': {
    fs: 20,
    n: {
      pattern: '@'
    }
  }
};
fWorkbook.addStyles(styles);

// Set values with the new styles
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:B2');
fRange.setValues([
  [{ v: 'Hello', s: 'custom-style-1' }, { v: 'Univer', s: 'custom-style-1' }],
  [{ v: 'To', s: 'custom-style-1' }, { v: '0001', s: 'custom-style-2' }],
]);

// Remove the style `custom-style-1` after 2 seconds
setTimeout(() => {
  fWorkbook.removeStyles(['custom-style-1']);
  fWorksheet.refreshCanvas();
}, 2000);

save(): IWorkbookData

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

async saveScreenshotToClipboard(): Promise<boolean>

searchCells(text: string | string[], options: ICustomSearchCellsOptions = {}): ICustomSearchCellsResult[]

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 worksheet
const 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

setPermissionDialogVisible(visible: boolean): void

setSpreadsheetLocale(locale: LocaleType): FWorkbook

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

showSelection(): FWorkbook

startEditing(): boolean

startZenEditingAsync(): Promise<boolean>

transparentSelection(): FWorkbook

undo(): FWorkbook

// The code below undoes the last action
const 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 workbook
const fWorkbook = univerAPI.getActiveWorkbook();
fWorkbook.setEditable(false);

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