Class: FWorkbook

addPivotTable(
   sourceInfo, 
   positionType, 
anchorCellInfo): Promise<FPivotTable>

// should ensure the sheet range {0,0,8,6} is not empty
const fWorkbook = univerAPI.getActiveWorkbook();
const unitId = fWorkbook.getId();
const fSheet = fWorkbook.getActiveSheet();
const subUnitId = fSheet.getSheetId();
const sheetName = fSheet.getSheetName();
const sourceInfo = {
  unitId,
  subUnitId,
  sheetName,
  range: {
    startRow: 0,
    endRow: 8,
    startColumn: 0,
    endColumn: 6
  }
};
const anchorCellInfo = {
  unitId,
  subUnitId,
  row: 20,
  col: 8
};
const fPivotTable = await fWorkbook.addPivotTable(sourceInfo, 'existing', anchorCellInfo);
const pivotTableId = fPivotTable.getPivotTableId();
let hasAdded = false;
// the addPivotTable is async, you can add pivot fields after the pivot table is added
univerAPI.addEvent(univerAPI.Event.PivotTableRendered, (params) => {
  if (!hasAdded && params.pivotTableId === pivotTableId) {
    fPivotTable.addField(1, univerAPI.Enum.PivotTableFiledAreaEnum.Row, 0);
    fPivotTable.addField(1, univerAPI.Enum.PivotTableFiledAreaEnum.Value, 0);
    hasAdded = true;
  }
});

clearComments(): Promise<boolean>

const workbook = univerAPI.getActiveWorkbook();
const success = await workbook.clearComments();

closePrintDialog(): void

univerAPI.getActiveWorkbook().closePrintDialog();

create(
   name, 
   rows, 
   column): FWorksheet

// The code below creates a new sheet
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const newSheet = activeSpreadsheet.create('MyNewSheet', 10, 10);

createRangeThemeStyle(themeName, themeStyleJson?): RangeThemeStyle

createSheetHyperlink(
   this, 
   sheetId, 
   range?): string

deleteActiveSheet(): boolean

// The code below deletes the currently active sheet and stores the new active
// sheet in a variable
const sheet = univerAPI.getActiveWorkbook().deleteActiveSheet();

deleteDefinedName(name): boolean

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

deleteSheet(sheet): boolean

// The code below deletes the specified worksheet
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const sheet = activeSpreadsheet.getSheetByName('Sheet1');
activeSpreadsheet.deleteSheet(sheet);

disableSelection(): FWorkbook

univerAPI.getActiveWorkbook().disableSelection();

duplicateActiveSheet(): FWorksheet

 const activeSpreadsheet = univerAPI.getActiveWorkbook();
 activeSpreadsheet.duplicateActiveSheet();

duplicateSheet(sheet): FWorksheet

// The code below duplicates the given worksheet
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const activeSheet = activeSpreadsheet.getActiveSheet();
activeSpreadsheet.duplicateSheet(activeSheet);

enableSelection(): FWorkbook

univerAPI.getActiveWorkbook().enableSelection();

endEditing(save?): Promise<boolean>

endEditingAsync(save?): Promise<boolean>

await univerAPI.getActiveWorkbook().endEditingAsync(false);

endZenEditingAsync(save?): Promise<boolean>

univerAPI.getActiveWorkbook().endZenEditingAsync(false);

getActiveRange(): FRange

getActiveSheet(): FWorksheet

// The code below gets the active sheet of the workbook
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const activeSheet = activeSpreadsheet.getActiveSheet();

getComments(): FThreadComment[]

const workbook = univerAPI.getActiveWorkbook();
const comments = workbook.getComments();

getCustomMetadata(): CustomData

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

getDefinedName(name): FDefinedName

// The code below gets the defined name by name
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const definedName = activeSpreadsheet.getDefinedName('MyDefinedName');

getDefinedNames(): FDefinedName[]

// The code below gets all the defined names in the workbook
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const definedNames = activeSpreadsheet.getDefinedNames();

getId(): string

// The code below gets the id of the workbook
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const id = activeSpreadsheet.getId();

getLocale(): LocaleType

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

getName(): string

// The code below gets the name of the workbook
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const name = activeSpreadsheet.getName();

getNumSheets(): number

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

getPermission(): FPermission

getPivotTableByCell(
   unitId, 
   subUnitId, 
   row, 
   col): FPivotTable

const fWorkbook = univerAPI.getActiveWorkbook();
const unitId = fWorkbook.getId();
const fSheet = fWorkbook.getActiveSheet();
const subUnitId = fSheet.getSheetId();
const pivotTable = fWorkbook.getPivotTableByCell(unitId, subUnitId, 1, 1);
if(pivotTable) {
  pivotTable.addField(1, univerAPI.Enum.PivotTableFiledAreaEnum.Row, 0);
}

getPivotTableById(pivotTableId): FPivotTable

const fWorkbook = univerAPI.getActiveWorkbook();
const mockId = 'abc123456';
const pivotTable = fWorkbook.getPivotTableById(mockId);
if(pivotTable) {
  pivotTable.addField(1, univerAPI.Enum.PivotTableFiledAreaEnum.Row, 0);
}

getRegisteredRangeThemes(): string[]

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

getScrollStateBySheetId(sheetId): any

getSheetByName(name): FWorksheet

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

getSheetBySheetId(sheetId): FWorksheet

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

getSheets(): FWorksheet[]

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

getSnapshot(): IWorkbookData

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

getUrl(): string

// The code below gets the URL of the workbook
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const url = activeSpreadsheet.getUrl();

getValidatorStatus(this): Promise<Record<..., ...>>

univerAPI.getActiveWorkbook().getValidatorStatus().then((status) => { console.log(status) })

getWorkbook(): Workbook

// The code below gets the Workbook instance
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const workbook = activeSpreadsheet.getWorkbook();

insertDefinedName(name, formulaOrRefString): FWorkbook

// The code below inserts a defined name
const activeSpreadsheet = univerAPI.getActiveWorkbook();
activeSpreadsheet.insertDefinedName('MyDefinedName', 'Sheet1!A1');

insertDefinedNameBuilder(param): void

// The code below inserts a defined name by builder param
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const builder = univerAPI.newDefinedName();
const param = builder.setName('MyDefinedName').setRef('Sheet1!A1').build();
activeSpreadsheet.insertDefinedNameBuilder(param);

insertSheet(sheetName?): FWorksheet

// The code below inserts a new sheet into the workbook
const activeSpreadsheet = univerAPI.getActiveWorkbook();
activeSpreadsheet.insertSheet();
 
// The code below inserts a new sheet into the workbook, using a custom name
const activeSpreadsheet = univerAPI.getActiveWorkbook();
activeSpreadsheet.insertSheet('MyNewSheet');

moveActiveSheet(index): FWorkbook

// The code below moves the active sheet to the specified index
const activeSpreadsheet = univerAPI.getActiveWorkbook();
activeSpreadsheet.moveActiveSheet(1);

moveSheet(sheet, index): FWorkbook

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

newColor(): ColorBuilder

onBeforeAddDataValidation(this, callback): IDisposable

onBeforeAddThreadComment(this, callback): IDisposable

onBeforeCommandExecute(callback): IDisposable

// The code below registers a callback that will be triggered before invoking a command targeting the Univer sheet
const activeSpreadsheet = univerAPI.getActiveWorkbook();
activeSpreadsheet.onBeforeCommandExecute((command) => {
  console.log('Command executed:', command);
});

onBeforeDeleteAllDataValidation(this, callback): IDisposable

onBeforeDeleteDataValidation(this, callback): IDisposable

onBeforeDeleteThreadComment(this, callback): IDisposable

onBeforeUpdateDataValidationCriteria(this, callback): IDisposable

onBeforeUpdateDataValidationOptions(this, callback): IDisposable

onBeforeUpdateDataValidationRange(this, callback): IDisposable

onBeforeUpdateThreadComment(this, callback): IDisposable

onCellClick(callback): IDisposable

onCellHover(callback): IDisposable

onCellPointerDown(callback): IDisposable

onCellPointerMove(callback): IDisposable

onCellPointerUp(callback): IDisposable

onCommandExecuted(callback): IDisposable

// The code below registers a callback that will be triggered when a command is invoked targeting the Univer sheet
const activeSpreadsheet = univerAPI.getActiveWorkbook();
activeSpreadsheet.onCommandExecuted((command) => {
  console.log('Command executed:', command);
});

onDataValidationChange(callback): IDisposable

onDataValidationStatusChange(callback): IDisposable

onDragOver(callback): IDisposable

onDrop(callback): IDisposable

onSelectionChange(callback): IDisposable

onThreadCommentChange(callback): IDisposable

openDialog(dialog): IDisposable

openPrintDialog(): void

univerAPI.getActiveWorkbook().openPrintDialog();

openSiderbar(params): IDisposable

parseSheetHyperlink(this, hyperlink): ISheetHyperLinkInfo

univerAPI.getActiveWorkbook().parseSheetHyperlink('#gid=sheet_Id&range=F6')

print(): void

univerAPI.getActiveWorkbook().print();

redo(): FWorkbook

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

registerRangeTheme(rangeThemeStyle): void

// import {RangeThemeStyle} from '@univerjs/sheets';
const fWorkbook = univerAPI.getActiveWorkbook();
const rangeThemeStyle = new RangeThemeStyle('MyTheme');
rangeThemeStyle.setSecondRowStyle({
  bg: {
    rgb: 'rgb(214,231,241)',
  },
});
fWorkbook.registerRangeTheme(rangeThemeStyle);

save(): IWorkbookData

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

saveScreenshotToClipboard(): Promise<boolean>

univerAPI.getActiveWorkbook().saveScreenshotToClipboard();

setActiveRange(range): FWorkbook

setActiveSheet(sheet): FWorksheet

// The code below sets the given worksheet to be the active worksheet
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const sheet = activeSpreadsheet.getSheetByName('Sheet1');
activeSpreadsheet.setActiveSheet(sheet);

setCustomMetadata(custom): FWorkbook

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

setEditable(value): FWorkbook

setLocale(locale): void

setName(name): void

// The code below sets the name of the workbook
const activeSpreadsheet = univerAPI.getActiveWorkbook();
activeSpreadsheet.setName('MyWorkbook');

setNumfmtLocal(local): FWorkbook

univerAPI.getActiveWorkbook().setNumfmtLocal('en')

setSpreadsheetLocale(locale): FWorkbook

// The code below sets the locale of the workbook
const activeSpreadsheet = univerAPI.getActiveWorkbook();
activeSpreadsheet.setLocale(LocaleType.EN_US);

showSelection(): FWorkbook

univerAPI.getActiveWorkbook().showSelection();

startEditing(): boolean

univerAPI.getActiveWorkbook().startEditing();

startZenEditingAsync(): Promise<boolean>

univerAPI.getActiveWorkbook().startZenEditingAsync();

transparentSelection(): FWorkbook

univerAPI.getActiveWorkbook().transparentSelection();

undo(): FWorkbook

// The code below undoes the last action
const activeSpreadsheet = univerAPI.getActiveWorkbook();
activeSpreadsheet.undo();

unregisterRangeTheme(themeName): void

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

updateDefinedNameBuilder(param): void

// The code below updates the defined name with the given name
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const builder = activeSpreadsheet.getDefinedName('MyDefinedName').toBuilder();
builder.setRef('Sheet1!A2').setName('MyDefinedName1').build();
activeSpreadsheet.updateDefinedNameBuilder(param);

updatePrintConfig(config): FWorkbook

univerAPI.getActiveWorkbook().updatePrintConfig({
  area: PrintArea.SHEET,
  subUnitIds: ['Sheet1'],
  id: 'Sheet1',
  pageSize: PrintPaperSize.A4,
  scale: PrintScale.FIT_PAGE,
  freeze: PrintFreeze.NONE,
  margin: {
    top: 0,
    bottom: 0,
    left: 0,
    right: 0,
  },
});

updatePrintRenderConfig(config): FWorkbook

univerAPI.getActiveWorkbook().updatePrintRenderConfig({
  headerFooter: PrintHeaderFooter.NONE,
  alignment: PrintAlignment.CENTER,
  gridline: PrintGridline.NONE,
});