@univerjs/sheets v0.5.0-beta.1 • Docs

Class: FWorkbook

FBase is a base class for all facade classes. It provides a way to extend classes with static and instance methods. The _initialize as a special method that will be called after the constructor. You should never call it directly.

Extends

• FBase

Extended by

Constructors

new FWorkbook()

new FWorkbook(
   _workbook, 
   _injector, 
   _resourceLoaderService, 
   _selectionManagerService, 
   _univerInstanceService, 
   _commandService, 
   _permissionService, 
   _logService): FWorkbook

Parameters

Returns

FWorkbook

Overrides

FBase.constructor

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:27

Properties

Methods

_initialize()

_initialize(): void

Returns

void

Inherited from

FBase._initialize

Defined in

submodules/univer/packages/core/src/facade/f-base.ts:33

create()

create(
   name, 
   rows, 
   column): FWorksheet

Create a new worksheet and returns a handle to it.

Parameters

Returns

FWorksheet

The new created sheet

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:94

deleteSheet()

deleteSheet(sheet): void

Deletes the specified worksheet.

Parameters

Returns

void

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:189

getActiveRange()

getActiveRange(): null | FRange

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

Returns

null | FRange

the active range

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:303

getActiveSheet()

getActiveSheet(): FWorksheet

Get the active sheet of the workbook.

Returns

FWorksheet

The active sheet of the workbook

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:72

getId()

getId(): string

Returns

string

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:42

getName()

getName(): string

Returns

string

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:46

getSheetByName()

getSheetByName(name): null | FWorksheet

Get a worksheet by sheet name.

Parameters

Returns

null | FWorksheet

The worksheet with given sheet name

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:139

getSheetBySheetId()

getSheetBySheetId(sheetId): null | FWorksheet

Get a worksheet by sheet id.

Parameters

Returns

null | FWorksheet

The worksheet with given sheet id

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:125

getSheets()

getSheets(): FWorksheet[]

Gets all the worksheets in this workbook

Returns

FWorksheet[]

An array of all the worksheets in the workbook

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:81

getSnapshot()

getSnapshot(): IWorkbookData

Returns

IWorkbookData

{IWorkbookData}

Deprecated

use ‘save’ instead.

Memberof

FWorkbook

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:63

insertSheet()

insertSheet(): FWorksheet

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

Returns

FWorksheet

The new sheet

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:167

onBeforeCommandExecute()

onBeforeCommandExecute(callback): IDisposable

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

Parameters

Returns

IDisposable

A function to dispose the listening.

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:215

onCommandExecuted()

onCommandExecuted(callback): IDisposable

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

Parameters

Returns

IDisposable

A function to dispose the listening.

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:230

onSelectionChange()

onSelectionChange(callback): IDisposable

Parameters

Returns

IDisposable

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:240

redo()

redo(): Promise<boolean>

Returns

Promise<boolean>

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:205

save()

save(): IWorkbookData

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

Returns

IWorkbookData

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:53

setActiveRange()

setActiveRange(range): void

Sets the active selection region for this sheet.

Parameters

Returns

void

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:274

setActiveSheet()

setActiveSheet(sheet): FWorksheet

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

Parameters

Returns

FWorksheet

The active worksheet

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:153

setEditable()

setEditable(value): void

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

Parameters

Returns

void

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:261

undo()

undo(): Promise<boolean>

Returns

Promise<boolean>

Defined in

submodules/univer/packages/sheets/src/facade/f-workbook.ts:200

extend()

static extend(source): void

Parameters

Returns

void

Inherited from

FBase.extend

Defined in

submodules/univer/packages/core/src/facade/f-base.ts:35