Skip to Content
ClassesFWorkbook

类: FWorkbook

Facade API object bounded to a workbook. It provides a set of methods to interact with the workbook.

继承

  • FBaseInitialable.IFWorkbookNumfmtMixin.IFWorkbookHyperlinkMixin.IFWorkbookDataValidationMixin.IFWorkbookConditionalFormattingMixin.IFWorkbookThreadCommentMixin.IFWorkbookSheetsPivotMixin.IFWorkbookSheetsUIMixin.IFWorkbookSheetsZenEditorMixin.IFWorkbookSheetsPrintMixin

属性

属性修饰符类型

id

readonly

string

方法

addPivotTable()

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

参数

参数类型描述
sourceInfoanyThe source data range info of the pivot table.
positionTypePositionTypewhether new a sheet or insert a pivot table to the existing sheet.
anchorCellInfoIPivotCellPositionInfoThe target cell info of the pivot table.

返回

Promise<FPivotTable>

The added pivot table id.

Description

Add a pivot table to the Workbook.

示例

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

clearComments(): Promise<boolean>;

Clear all comments in the current workbook

返回

Promise<boolean>

Whether the comments are cleared successfully.

示例

const fWorkbook = univerAPI.getActiveWorkbook(); const result = await fWorkbook.clearComments(); console.log(result);

closePrintDialog()

closePrintDialog(): void;

Close print preview dialog.

返回

void

示例

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

create()

create( name, rows, columns, options?): FWorksheet;

Create a new worksheet and returns a handle to it.

参数

参数类型描述
namestringName of the new sheet
rowsnumberHow many rows would the new sheet have
columnsnumberHow many columns would the new sheet have
options?Pick<IInsertSheetCommandParams, … | …>The options for the new sheet

返回

FWorksheet

The new created sheet

示例

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()

createRangeThemeStyle(themeName, themeStyleJson?): RangeThemeStyle;

Create a range theme style.

参数

参数类型描述
themeNamestringThe name of the theme to register
themeStyleJson?Omit<IRangeThemeStyleJSON, "name">The theme style json to register

返回

RangeThemeStyle

  • The created range theme style

示例

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

createSheetHyperlink( this, sheetId, range?): string;

参数

参数类型
thisFWorkbook
sheetIdstring
range?string | IRange

返回

string

已被弃用

use getUrl method in FRange or FWorksheet instead.


deleteActiveSheet()

deleteActiveSheet(): boolean;

Deletes the currently active sheet.

返回

boolean

true if the sheet was deleted, false otherwise

示例

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

deleteDefinedName()

deleteDefinedName(name): boolean;

Delete the defined name with the given name.

参数

参数类型描述
namestringThe name of the defined name to delete

返回

boolean

true if the defined name was deleted, false otherwise

示例

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

deleteSheet()

deleteSheet(sheet): boolean;

Deletes the specified worksheet.

参数

参数类型描述
sheetstring | FWorksheetThe instance or id of the worksheet to delete.

返回

boolean

True if the worksheet was deleted, false otherwise.

示例

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

disableSelection(): FWorkbook;

Disable selection. After disabled, there would be no response for selection.

返回

FWorkbook

FWorkbook instance for chaining

示例

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

duplicateActiveSheet()

duplicateActiveSheet(): FWorksheet;

Duplicates the active sheet.

返回

FWorksheet

The duplicated worksheet

示例

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

duplicateSheet()

duplicateSheet(sheet): FWorksheet;

Duplicates the given worksheet.

参数

参数类型描述
sheetFWorksheetThe worksheet to duplicate.

返回

FWorksheet

The duplicated worksheet

示例

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

enableSelection()

enableSelection(): FWorkbook;

Enable selection. After this you can select range.

返回

FWorkbook

FWorkbook instance for chaining

示例

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

endEditing()

endEditing(save?): Promise<boolean>;

参数

参数类型
save?boolean

返回

Promise<boolean>

已被弃用

Use endEditingAsync as instead


endEditingAsync()

endEditingAsync(save?): Promise<boolean>;

参数

参数类型描述
save?booleanWhether to save the changes, default is true

返回

Promise<boolean>

Whether the editing process is ended successfully

Async

End the editing process of the current active cell

示例

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

endZenEditingAsync()

endZenEditingAsync(save?): Promise<boolean>;

End the zen editing process on the active cell and optionally save the changes

参数

参数类型描述
save?booleanWhether to save the changes, default is true

返回

Promise<boolean>

A promise that resolves to a boolean indicating whether the zen editing process was ended successfully.

Async

示例

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

getActiveCell()

getActiveCell(): FRange;

Returns the active cell in this spreadsheet.

返回

FRange

The active cell

示例

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

getActiveRange()

getActiveRange(): FRange;

Returns the selected range in the active sheet, or null if there is no active range.

返回

FRange

The active range

示例

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

getActiveSheet()

getActiveSheet(): FWorksheet;

Get the active sheet of the workbook.

返回

FWorksheet

The active sheet of the workbook

示例

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

getComments()

getComments(): FThreadComment[];

Get all comments in the current workbook

返回

FThreadComment[]

All comments in the current workbook

示例

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()

getCustomMetadata(): CustomData;

Get custom metadata of workbook

返回

CustomData

custom metadata

示例

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

getDefinedName()

getDefinedName(name): FDefinedName;

Get the defined name by name.

参数

参数类型描述
namestringThe name of the defined name to get

返回

FDefinedName

The defined name with the given name

示例

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

getDefinedNames(): FDefinedName[];

Get all the defined names in the workbook.

返回

FDefinedName[]

All the defined names in the workbook

示例

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

getId()

getId(): string;

Get the id of the workbook.

返回

string

The id of the workbook.

示例

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

getLocale()

getLocale(): LocaleType;

Get the locale of the workbook.

返回

LocaleType

The locale of the workbook

示例

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

getName()

getName(): string;

Get the name of the workbook.

返回

string

The name of the workbook.

示例

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

getNumSheets()

getNumSheets(): number;

Get the number of sheets in the workbook.

返回

number

The number of sheets in the workbook

示例

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

getPermission()

getPermission(): FPermission;

Get the PermissionInstance.

返回

FPermission

  • The PermissionInstance.

示例

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

getPivotTableByCell()

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

参数

参数类型描述
unitIdstringThe unit id of workbook.
subUnitIdstringThe sheet id, which pivot table belongs to.
rownumberThe checked row.
colnumberThe checked column.

返回

FPivotTable

The pivot table instance or undefined.

Description

Get the pivot table id by the cell.

示例

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()

getPivotTableById(pivotTableId): FPivotTable;

参数

参数类型描述
pivotTableIdstringThe pivot table id.

返回

FPivotTable

The pivot table instance or undefined.

Description

Get the pivot table by the pivot table id.

示例

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

getRegisteredRangeThemes()

getRegisteredRangeThemes(): string[];

Gets the registered range themes.

返回

string[]

The name list of registered range themes.

示例

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

getScrollStateBySheetId()

getScrollStateBySheetId(sheetId): any;

Get scroll state of specified sheet.

参数

参数类型描述
sheetIdstringsheet id

返回

any

scroll state

示例

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()

getSheetByName(name): FWorksheet;

Get a worksheet by sheet name.

参数

参数类型描述
namestringThe name of the sheet to get.

返回

FWorksheet

The worksheet with given sheet name

示例

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

getSheetBySheetId()

getSheetBySheetId(sheetId): FWorksheet;

Get a worksheet by sheet id.

参数

参数类型描述
sheetIdstringThe id of the sheet to get.

返回

FWorksheet

The worksheet with given sheet id

示例

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

getSheets()

getSheets(): FWorksheet[];

Gets all the worksheets in this workbook

返回

FWorksheet[]

An array of all the worksheets in the workbook

示例

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

getSnapshot()

getSnapshot(): IWorkbookData;

返回

IWorkbookData

Workbook snapshot data

已被弃用

use ‘save’ instead.

Memberof

FWorkbook

示例

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

getUrl()

getUrl(): string;

Get the URL of the workbook.

返回

string

The URL of the workbook

示例

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

getValidatorStatus()

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

Get data validation validator status for current workbook.

返回

Promise<Record<…, …>>

A promise that resolves to a matrix of validator status.

示例

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

getWorkbook()

getWorkbook(): Workbook;

Get the Workbook instance.

返回

Workbook

The Workbook instance.

示例

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

insertDefinedName()

insertDefinedName(name, formulaOrRefString): FWorkbook;

Insert a defined name.

参数

参数类型描述
namestringThe name of the defined name to insert
formulaOrRefStringstringThe formula(=sum(A2:b10)) or reference(A1) string of the defined name to insert

返回

FWorkbook

The current FWorkbook instance

示例

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

insertDefinedNameBuilder()

insertDefinedNameBuilder(param): void;

Insert a defined name by builder param.

参数

参数类型描述
paramISetDefinedNameMutationParamThe param to insert the defined name

返回

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()

insertSheet(sheetName?, options?): FWorksheet;

Inserts a new worksheet into the workbook. Using a default sheet name. The new sheet becomes the active sheet

参数

参数类型描述
sheetName?stringThe name of the new sheet
options?Pick<IInsertSheetCommandParams, … | …>The options for the new sheet

返回

FWorksheet

The new sheet

示例

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

moveActiveSheet()

moveActiveSheet(index): FWorkbook;

Move the active sheet to the specified index.

参数

参数类型描述
indexnumberThe index to move the active sheet to

返回

FWorkbook

This workbook, for chaining

示例

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

moveSheet()

moveSheet(sheet, index): FWorkbook;

Move the sheet to the specified index.

参数

参数类型描述
sheetFWorksheetThe sheet to move
indexnumberThe index to move the sheet to

返回

FWorkbook

This workbook, for chaining

示例

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

newColor()

newColor(): ColorBuilder;

返回

ColorBuilder

已被弃用

use univerAPI.newColor() as instead.


onBeforeAddDataValidation()

onBeforeAddDataValidation(this, callback): IDisposable;

参数

参数类型
thisFWorkbook
callback(params, options) => … | …

返回

IDisposable

已被弃用

Use univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationAdd, (event) => { ... }) instead


onBeforeAddThreadComment()

onBeforeAddThreadComment(this, callback): IDisposable;

参数

参数类型
thisFWorkbook
callback(params, options) => … | …

返回

IDisposable

已被弃用

use univerAPI.addEvent(univerAPI.Event.BeforeCommentAdd, (params) => {}) as instead


onBeforeCommandExecute()

onBeforeCommandExecute(callback): IDisposable;

Register a callback that will be triggered before invoking a command targeting the Univer sheet.

参数

参数类型描述
callbackCommandListenerthe callback.

返回

IDisposable

A function to dispose the listening.

示例

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

onBeforeDeleteAllDataValidation(this, callback): IDisposable;

参数

参数类型
thisFWorkbook
callback(params, options) => … | …

返回

IDisposable

已被弃用

Use univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationDeleteAll, (event) => { ... }) instead


onBeforeDeleteDataValidation()

onBeforeDeleteDataValidation(this, callback): IDisposable;

参数

参数类型
thisFWorkbook
callback(params, options) => … | …

返回

IDisposable

已被弃用

Use univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationDelete, (event) => { ... }) instead


onBeforeDeleteThreadComment()

onBeforeDeleteThreadComment(this, callback): IDisposable;

参数

参数类型
thisFWorkbook
callback(params, options) => … | …

返回

IDisposable

已被弃用

use univerAPI.addEvent(univerAPI.Event.BeforeCommentDelete, (params) => {}) as instead


onBeforeUpdateDataValidationCriteria()

onBeforeUpdateDataValidationCriteria(this, callback): IDisposable;

参数

参数类型
thisFWorkbook
callback(params, options) => … | …

返回

IDisposable

已被弃用

Use univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationCriteriaUpdate, (event) => { ... }) instead


onBeforeUpdateDataValidationOptions()

onBeforeUpdateDataValidationOptions(this, callback): IDisposable;

参数

参数类型
thisFWorkbook
callback(params, options) => … | …

返回

IDisposable

已被弃用

Use univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationOptionsUpdate, (event) => { ... }) instead


onBeforeUpdateDataValidationRange()

onBeforeUpdateDataValidationRange(this, callback): IDisposable;

参数

参数类型
thisFWorkbook
callback(params, options) => … | …

返回

IDisposable

已被弃用

Use univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationRangeUpdate, (event) => { ... }) instead


onBeforeUpdateThreadComment()

onBeforeUpdateThreadComment(this, callback): IDisposable;

参数

参数类型
thisFWorkbook
callback(params, options) => … | …

返回

IDisposable

已被弃用

use univerAPI.addEvent(univerAPI.Event.BeforeCommentUpdate, (params) => {}) as instead


onCellClick()

onCellClick(callback): IDisposable;

参数

参数类型
callback(cell) => void

返回

IDisposable

已被弃用

use univerAPI.addEvent(univerAPI.Event.CellClicked, (params) => {}) instead


onCellHover()

onCellHover(callback): IDisposable;

参数

参数类型
callback(cell) => void

返回

IDisposable

已被弃用

use univerAPI.addEvent(univerAPI.Event.CellHover, (params) => {}) instead


onCellPointerDown()

onCellPointerDown(callback): IDisposable;

参数

参数类型
callback(cell) => void

返回

IDisposable

已被弃用

use univerAPI.addEvent(univerAPI.Event.CellPointerDown, (params) => {}) instead


onCellPointerMove()

onCellPointerMove(callback): IDisposable;

参数

参数类型
callback(cell, event) => void

返回

IDisposable

已被弃用

use univerAPI.addEvent(univerAPI.Event.CellPointerMove, (params) => {}) instead


onCellPointerUp()

onCellPointerUp(callback): IDisposable;

参数

参数类型
callback(cell) => void

返回

IDisposable

已被弃用

use univerAPI.addEvent(univerAPI.Event.CellPointerUp, (params) => {}) instead


onCommandExecuted()

onCommandExecuted(callback): IDisposable;

Register a callback that will be triggered when a command is invoked targeting the Univer sheet.

参数

参数类型描述
callbackCommandListenerthe callback.

返回

IDisposable

A function to dispose the listening.

示例

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

onDataValidationChange(callback): IDisposable;

参数

参数类型
callback(ruleChange) => void

返回

IDisposable

已被弃用

Use univerAPI.addEvent(univerAPI.Event.SheetDataValidationChanged, (event) => { ... }) instead


onDataValidationStatusChange()

onDataValidationStatusChange(callback): IDisposable;

参数

参数类型
callback(statusChange) => void

返回

IDisposable

已被弃用

Use univerAPI.addEvent(univerAPI.Event.SheetDataValidatorStatusChanged, (event) => { ... }) instead


onDragOver()

onDragOver(callback): IDisposable;

参数

参数类型
callback(cell) => void

返回

IDisposable

已被弃用

use univerAPI.addEvent(univerAPI.Event.DragOver, (params) => {}) instead


onDrop()

onDrop(callback): IDisposable;

参数

参数类型
callback(cell) => void

返回

IDisposable

已被弃用

use univerAPI.addEvent(univerAPI.Event.Drop, (params) => {}) instead


onSelectionChange()

onSelectionChange(callback): IDisposable;

Register a callback that will be triggered when the selection changes.

参数

参数类型描述
callback(selections) => voidThe callback.

返回

IDisposable

A function to dispose the listening

示例

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

onThreadCommentChange(callback): IDisposable;

参数

参数类型
callback(commentUpdate) => … | …

返回

IDisposable

已被弃用

use univerAPI.addEvent(univerAPI.Event.CommentUpdated, (params) => {}) as instead


openDialog()

openDialog(dialog): IDisposable;

Open a dialog.

参数

参数类型描述
dialogIDialogPartMethodOptionsthe dialog options

返回

IDisposable

the disposable object

已被弃用

use univerAPI.openDialog instead

示例

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 variant="primary" onClick={() => { console.log('Confirm clicked') }} style={{marginLeft: '10px'}}>Confirm</Button> </> ) }, draggable: true, mask: true, maskClosable: true, });

openPrintDialog()

openPrintDialog(): void;

Open print preview dialog.

返回

void

示例

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

openSiderbar()

openSiderbar(params): IDisposable;

Open a sidebar.

参数

参数类型描述
paramsISidebarMethodOptionsthe sidebar options

返回

IDisposable

the disposable object

已被弃用

use univerAPI.openSidebar instead

示例

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;

Parse the hyperlink string to get the hyperlink info.

参数

参数类型描述
thisFWorkbook-
hyperlinkstringThe hyperlink string.

返回

ISheetHyperLinkInfo

The hyperlink info.

示例

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

print(): void;

Using current print config and render config to 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()

redo(): FWorkbook;

Redo the last undone action.

返回

FWorkbook

A promise that resolves to true if the redo was successful, false otherwise.

示例

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

registerRangeTheme()

registerRangeTheme(rangeThemeStyle): void;

Register a custom range theme style.

参数

参数类型描述
rangeThemeStyleRangeThemeStyleThe range theme style to register

返回

void

示例

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

save()

save(): IWorkbookData;

Save workbook snapshot data, including conditional formatting, data validation, and other plugin data.

返回

IWorkbookData

Workbook snapshot data

示例

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

saveScreenshotToClipboard()

saveScreenshotToClipboard(): Promise<boolean>;

Save screenshot of current range to clipboard. This API is only available with a license. Without a license, usage is restricted, and save operations will return false. We use the Clipboard API to save the image to the clipboard, which may fail in an insecure network environment or in some unsupported browsers. A successful save will return true.

返回

Promise<boolean>

  • The result of saving the screenshot to the clipboard.

示例

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

setActiveRange()

setActiveRange(range): FWorkbook;

Sets the selection region for active sheet.

参数

参数类型描述
rangeFRangeThe range to set as the active selection.

返回

FWorkbook

FWorkbook instance

示例

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

setActiveSheet()

setActiveSheet(sheet): FWorksheet;

Sets the given worksheet to be the active worksheet in the workbook.

参数

参数类型描述
sheetstring | FWorksheetThe instance or id of the worksheet to set as active.

返回

FWorksheet

The active worksheet

示例

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

setCustomMetadata(custom): FWorkbook;

Set custom metadata of workbook

参数

参数类型描述
customCustomDatacustom metadata

返回

FWorkbook

FWorkbook

示例

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

setEditable()

setEditable(value): FWorkbook;

Used to modify the editing permissions of the workbook. When the value is false, editing is not allowed.

参数

参数类型描述
valuebooleaneditable value want to set

返回

FWorkbook

FWorkbook instance

示例

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

setLocale()

setLocale(locale): void;

参数

参数类型描述
localeLocaleTypeThe locale to set

返回

void

已被弃用

use setSpreadsheetLocale instead.


setName()

setName(name): void;

Set the name of the workbook.

参数

参数类型描述
namestringThe new name of the workbook.

返回

void

示例

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

setNumfmtLocal()

setNumfmtLocal(local): FWorkbook;

Set the locale for number formatting.

参数

参数类型描述
localLocaleTagzh_CN,zh_TW,zh_HK,ja,ko,th,cs,da,nl,en,en_AU,en_CA,en_GB,en_IE,fi,fr,fr_CA,fr_CH,de,de_CH,el,hu,is,id,it,it_CH,nb,no,pl,pt,pt_BR,ru,sk,es,es_AR,es_BO,es_CL,es_CO,es_EC,es_MX,es_PY,es_UY,es_VE,sv,tr,cy,az,be,bg,ca,fil,gu,he,hr,hy,ka,kk,kn,lt,lv,ml,mn,mr,my,pa,ro,sl,sr,ta,te,uk,vi,ar,bn,hi

返回

FWorkbook

The FWorkbook instance for chaining.

Memberof

IFWorkbookNumfmtMixin

示例

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

继承自

IFWorkbookNumfmtMixin.setNumfmtLocal


setSpreadsheetLocale()

setSpreadsheetLocale(locale): FWorkbook;

Set the locale of the workbook.

参数

参数类型描述
localeLocaleTypeThe locale to set

返回

FWorkbook

This workbook, for chaining

示例

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

showSelection(): FWorkbook;

Set selection visible.

返回

FWorkbook

FWorkbook instance for chaining

示例

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

startEditing()

startEditing(): boolean;

Start the editing process of the current active cell

返回

boolean

Whether the editing process is started successfully

示例

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

startZenEditingAsync()

startZenEditingAsync(): Promise<boolean>;

Enter the zen editing process on the active cell

返回

Promise<boolean>

A promise that resolves to a boolean indicating whether the zen editing process was started successfully.

示例

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

transparentSelection()

transparentSelection(): FWorkbook;

Set selection invisible, Unlike disableSelection, selection still works, you just can not see them.

返回

FWorkbook

FWorkbook instance for chaining

示例

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

undo()

undo(): FWorkbook;

Undo the last action.

返回

FWorkbook

A promise that resolves to true if the undo was successful, false otherwise.

示例

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

unregisterRangeTheme()

unregisterRangeTheme(themeName): void;

Unregister a custom range theme style.

参数

参数类型描述
themeNamestringThe name of the theme to unregister

返回

void

示例

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

updateDefinedNameBuilder()

updateDefinedNameBuilder(param): void;

Update the defined name with the given name.

参数

参数类型描述
paramISetDefinedNameMutationParamThe param to insert the defined name

返回

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

updatePrintConfig()

updatePrintConfig(config): FWorkbook;

Update print config, include print area, page-setting, scale, freeze, margin, and etc.

参数

参数类型描述
configISheetPrintLayoutConfigThe print layout config.

返回

FWorkbook

  • The current workbook instance for chaining.

示例

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()

updatePrintRenderConfig(config): FWorkbook;

Update print render config, include print header-footer setting, alignment, gridline, and etc.

参数

参数类型描述
configISheetPrintRenderConfigThe print render config.

返回

FWorkbook

  • The current workbook instance for chaining.

示例

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