类: FWorkbook

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

// should ensure the sheet range A1:G9 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: 0,
  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 fWorkbook = univerAPI.getActiveWorkbook();
const result = await fWorkbook.clearComments();
console.log(result);

closePrintDialog(): void

const fWorkbook = univerAPI.getActiveWorkbook();
fWorkbook.openPrintDialog();
 
// Close print dialog after 3 seconds
setTimeout(() => {
  fWorkbook.closePrintDialog();
}, 3000);

create(
   name, 
   rows, 
   column): FWorksheet

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

createRangeThemeStyle(themeName, themeStyleJson?): RangeThemeStyle

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

createSheetHyperlink(
   this, 
   sheetId, 
   range?): string

deleteActiveSheet(): boolean

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

deleteDefinedName(name): boolean

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

deleteSheet(sheet): 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());

disableSelection(): FWorkbook

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

duplicateActiveSheet(): FWorksheet

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

duplicateSheet(sheet): 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

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

endEditing(save?): Promise<boolean>

endEditingAsync(save?): Promise<boolean>

const fWorkbook = univerAPI.getActiveWorkbook();
await fWorkbook.endEditingAsync(false);

endZenEditingAsync(save?): Promise<boolean>

const fWorkbook = univerAPI.getActiveWorkbook();
const success = await fWorkbook.endZenEditingAsync(false);
console.log(success);

getActiveCell(): FRange

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

getActiveRange(): FRange

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

getActiveSheet(): FWorksheet

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

getComments(): FThreadComment[]

const fWorkbook = univerAPI.getActiveWorkbook();
const comments = fWorkbook.getComments();
comments.forEach((comment) => {
  const isRoot = comment.getIsRoot();
 
  if (isRoot) {
    console.log('root comment:', comment.getCommentData());
 
    const replies = comment.getReplies();
    replies.forEach((reply) => {
      console.log('reply comment:', reply.getCommentData());
    });
  }
});

getCustomMetadata(): CustomData

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

getDefinedName(name): FDefinedName

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

getDefinedNames(): FDefinedName[]

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

getId(): string

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

getLocale(): LocaleType

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

getName(): string

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

getNumSheets(): number

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

getPermission(): FPermission

const fWorkbook = univerAPI.getActiveWorkbook();
const permission = fWorkbook.getPermission();
console.log(permission);

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

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

getPivotTableById(pivotTableId): FPivotTable

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

getRegisteredRangeThemes(): string[]

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

getScrollStateBySheetId(sheetId): any

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
 
// scroll to cell D10
fWorksheet.scrollToCell(9, 3);
 
// get scroll state
const scrollState = fWorkbook.getScrollStateBySheetId(fWorksheet.getSheetId());
const { offsetX, offsetY, sheetViewStartRow, sheetViewStartColumn } = scrollState;
console.log(scrollState); // sheetViewStartRow: 9, sheetViewStartColumn: 3, offsetX: 0, offsetY: 0

getSheetByName(name): FWorksheet

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

getSheetBySheetId(sheetId): FWorksheet

// 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);

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 fWorkbook = univerAPI.getActiveWorkbook();
const url = fWorkbook.getUrl();
console.log(url);

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

const fWorkbook = univerAPI.getActiveWorkbook();
const status = await fWorkbook.getValidatorStatus();
console.log(status);

getWorkbook(): Workbook

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

insertDefinedName(name, formulaOrRefString): FWorkbook

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

insertDefinedNameBuilder(param): 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?): FWorksheet

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

moveActiveSheet(index): FWorkbook

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

moveSheet(sheet, index): FWorkbook

// The code below moves the sheet to the specified index
const fWorkbook = univerAPI.getActiveWorkbook();
const sheet = fWorkbook.getActiveSheet();
fWorkbook.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 fWorkbook = univerAPI.getActiveWorkbook();
fWorkbook.onBeforeCommandExecute((command) => {
  console.log('Before command execute:', 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 fWorkbook = univerAPI.getActiveWorkbook();
fWorkbook.onCommandExecuted((command) => {
  console.log('Command executed:', command);
});

onDataValidationChange(callback): IDisposable

onDataValidationStatusChange(callback): IDisposable

onDragOver(callback): IDisposable

onDrop(callback): IDisposable

onSelectionChange(callback): IDisposable

// The code below registers a callback that will be triggered when the selection changes
const fWorkbook = univerAPI.getActiveWorkbook();
fWorkbook.onSelectionChange((selections) => {
  console.log('Selection changed:', selections);
});

onThreadCommentChange(callback): IDisposable

openDialog(dialog): IDisposable

import { Button } from '@univerjs/design';
 
univerAPI.openDialog({
  id: 'mock-dialog-id',
  width: 500,
  title: {
    label: 'Dialog Title',
  },
  children: {
    label: 'Dialog Content',
  },
  footer: {
    title: (
      <>
        <Button onClick={() => { console.log('Cancel clicked') }}>Cancel</Button>
        <Button type="primary" onClick={() => { console.log('Confirm clicked') }} style={{marginLeft: '10px'}}>Confirm</Button>
      </>
    )
  },
  draggable: true,
  mask: true,
  maskClosable: true,
});

openPrintDialog(): void

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

openSiderbar(params): IDisposable

univerAPI.openSidebar({
  id: 'mock-sidebar-id',
  width: 300,
  header: {
    label: 'Sidebar Header',
  },
  children: {
    label: 'Sidebar Content',
  },
  footer: {
    label: 'Sidebar Footer',
  },
  onClose: () => {
    console.log('Sidebar closed')
  },
});

parseSheetHyperlink(this, hyperlink): ISheetHyperLinkInfo

// Create a hyperlink to the range A1:D10 of the current sheet
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:D10');
const hyperlink = fRange.getUrl();
 
// Parse the hyperlink
const hyperlinkInfo = fWorkbook.parseSheetHyperlink(hyperlink);
console.log(hyperlinkInfo);

print(): void

const fWorkbook = univerAPI.getActiveWorkbook();
 
// Update print layout config by default
fWorkbook.updatePrintConfig({});
 
// Update print render config by default
fWorkbook.updatePrintRenderConfig({});
 
// Start print
fWorkbook.print();

redo(): FWorkbook

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

registerRangeTheme(rangeThemeStyle): void

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

save(): IWorkbookData

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

saveScreenshotToClipboard(): Promise<boolean>

const fWorkbook = univerAPI.getActiveWorkbook();
const result = await fWorkbook.saveScreenshotToClipboard();
console.log(result); // true or false

setActiveRange(range): FWorkbook

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

setActiveSheet(sheet): 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): FWorkbook

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

setEditable(value): FWorkbook

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

setLocale(locale): void

setName(name): void

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

setNumfmtLocal(local): FWorkbook

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1');
fRange.setValue(1234.567).setNumberFormat('#,##0.00');
 
// Set the locale en_US for number formatting.
fWorkbook.setNumfmtLocal('en_US');
console.log(fRange.getDisplayValue()); // 1,234.57
 
// Set the locale de_DE for number formatting.
fWorkbook.setNumfmtLocal('de_DE');
console.log(fRange.getDisplayValue()); // 1.234,57

setSpreadsheetLocale(locale): 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

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

startEditing(): boolean

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

startZenEditingAsync(): Promise<boolean>

const fWorkbook = univerAPI.getActiveWorkbook();
const success = await fWorkbook.startZenEditingAsync();
console.log(success);

transparentSelection(): FWorkbook

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

undo(): FWorkbook

// The code below undoes the last action
const fWorkbook = univerAPI.getActiveWorkbook();
fWorkbook.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 fWorkbook = univerAPI.getActiveWorkbook();
const definedNameBuilder = fWorkbook.getDefinedName('MyDefinedName').toBuilder();
const param = definedNameBuilder.setRef('Sheet1!A2')
  .setName('NewDefinedName')
  .build();
fWorkbook.updateDefinedNameBuilder(param);

updatePrintConfig(config): FWorkbook

const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const subUnitId = fWorksheet.getSheetId();
 
// Update print layout config
fWorkbook.updatePrintConfig({
  area: univerAPI.Enum.PrintArea.CurrentSheet, // print current sheet
  subUnitIds: [subUnitId],
  paperSize: univerAPI.Enum.PrintPaperSize.A4, // A4 paper size
  scale: univerAPI.Enum.PrintScale.FitPage, // fit content to page
  freeze: [univerAPI.Enum.PrintFreeze.Row], // freeze row headers
  margin: univerAPI.Enum.PrintPaperMargin.Normal, // normal margin
  // ... other settings
});
 
// Start print
fWorkbook.print();

updatePrintRenderConfig(config): FWorkbook

const fWorkbook = univerAPI.getActiveWorkbook();
 
// Update print layout config by default
fWorkbook.updatePrintConfig({});
 
// Update print render config
fWorkbook.updatePrintRenderConfig({
  gridlines: true, // show gridlines
  hAlign: univerAPI.Enum.PrintAlign.Middle, // horizontal align middle
  vAlign: univerAPI.Enum.PrintAlign.Middle, // vertical align middle
  headerFooter: [ // the array of header and footer elements to include, here is page numbers and worksheet name
    univerAPI.Enum.PrintHeaderFooter.PageSize,
    univerAPI.Enum.PrintHeaderFooter.WorksheetTitle
  ],
  // ... other settings
});
 
// Start print
fWorkbook.print();