Class: Workbook

Access and create Univer Sheets files

Extends

UnitModel<IWorkbookData, UniverInstanceType.UNIVER_SHEET>

Constructors

new Workbook()

new Workbook(workbookData, _logService): Workbook

Parameters

Parameter	Type
`workbookData`	`Partial`<`IWorkbookData`>
`_logService`	`ILogService`

Properties

Property	Modifier	Type	Default value	Overrides	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	-	`UnitModel`.`_disposed`	submodules/univer/packages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
`activeSheet$`	`readonly`	`Observable`<`Nullable`<`Worksheet`>>	`undefined`	-	-	submodules/univer/packages/core/src/sheets/workbook.ts:48 (opens in a new tab)
`name$`	`readonly`	`Observable`<`string`>	`undefined`	`UnitModel`.`name$`	-	submodules/univer/packages/core/src/sheets/workbook.ts:75 (opens in a new tab)
`sheetCreated$`	`readonly`	`Observable`<`Worksheet`>	`undefined`	-	-	submodules/univer/packages/core/src/sheets/workbook.ts:41 (opens in a new tab)
`sheetDisposed$`	`readonly`	`Observable`<`Worksheet`>	`undefined`	-	-	submodules/univer/packages/core/src/sheets/workbook.ts:44 (opens in a new tab)
`type`	`public`	`UNIVER_SHEET`	`UniverInstanceType.UNIVER_SHEET`	`UnitModel`.`type`	-	submodules/univer/packages/core/src/sheets/workbook.ts:38 (opens in a new tab)

Accessors

name

get name(): string

Returns

string

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:76 (opens in a new tab)

Methods

addWorksheet()

addWorksheet(
   id, 
   index, 
   worksheetSnapshot): boolean

Add a Worksheet into Workbook.

Parameters

Parameter	Type
`id`	`string`
`index`	`number`
`worksheetSnapshot`	`Partial`<`IWorksheetData`>

Returns

boolean

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:170 (opens in a new tab)

checkSheetName()

checkSheetName(name): boolean

Check if sheet name is unique

Parameters

Parameter	Type	Description
`name`	`string`	sheet name

Returns

boolean

True if sheet name is unique

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:358 (opens in a new tab)

dispose()

dispose(): void

Returns

void

Overrides

UnitModel.dispose

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:113 (opens in a new tab)

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

UnitModel.disposeWithMe

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)

ensureActiveSheet()

ensureActiveSheet(): Worksheet

If there is no active sheet, the first sheet would be set active.

Returns

Worksheet

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:228 (opens in a new tab)

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

UnitModel.ensureNotDisposed

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)

generateNewSheetName()

generateNewSheetName(name): string

Automatically generate new sheet name

Parameters

Parameter	Type	Description
`name`	`string`	sheet name

Returns

string

New sheet name

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:382 (opens in a new tab)

getActiveSheet()

getActiveSheet(undefined)

getActiveSheet(): Worksheet

Get the active sheet.

Returns

Worksheet

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:213 (opens in a new tab)

getActiveSheet(allowNull)

getActiveSheet(allowNull): Nullable<Worksheet>

Parameters

Parameter	Type
`allowNull`	`true`

Returns

Nullable<Worksheet>

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:214 (opens in a new tab)

getActiveSheetIndex()

getActiveSheetIndex(): number

Returns

number

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:274 (opens in a new tab)

getActiveSpreadsheet()

getActiveSpreadsheet(): Workbook

Returns

Workbook

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:193 (opens in a new tab)

getConfig()

getConfig(): IWorkbookData

Returns

IWorkbookData

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:201 (opens in a new tab)

getHiddenWorksheets()

getHiddenWorksheets(): string[]

Returns

string[]

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:336 (opens in a new tab)

getIndexBySheetId()

getIndexBySheetId(sheetId): number

Parameters

Parameter	Type
`sheetId`	`string`

Returns

number

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:205 (opens in a new tab)

getName()

getName(): string

Returns

string

Deprecated

use use name property instead

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:142 (opens in a new tab)

getRev()

getRev(): number

Get revision of the unit's snapshot. Note that revision should start from 1.

Returns

number

Overrides

UnitModel.getRev

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:155 (opens in a new tab)

getSheetByIndex()

getSheetByIndex(index): Nullable<Worksheet>

Parameters

Parameter	Type
`index`	`number`

Returns

Nullable<Worksheet>

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:331 (opens in a new tab)

getSheetBySheetId()

getSheetBySheetId(sheetId): Nullable<Worksheet>

Parameters

Parameter	Type
`sheetId`	`string`

Returns

Nullable<Worksheet>

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:327 (opens in a new tab)

getSheetBySheetName()

getSheetBySheetName(name): Nullable<Worksheet>

Parameters

Parameter	Type
`name`	`string`

Returns

Nullable<Worksheet>

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:318 (opens in a new tab)

getSheetIndex()

getSheetIndex(sheet): number

Parameters

Parameter	Type
`sheet`	`Worksheet`

Returns

number

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:307 (opens in a new tab)

getSheetOrders()

getSheetOrders(): readonly string[]

Returns

readonly string[]

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:185 (opens in a new tab)

getSheetSize()

getSheetSize(): number

Returns

number

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:282 (opens in a new tab)

getSheets()

getSheets(): Worksheet[]

Returns

Worksheet[]

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:286 (opens in a new tab)

getSheetsName()

getSheetsName(): string[]

Returns

string[]

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:292 (opens in a new tab)

getSnapshot()

getSnapshot(): IWorkbookData

Get current snapshot reference. Call resourceLoaderService.saveWorkbook to save the data associated with the current plugin if needed.

Returns

IWorkbookData

{IWorkbookData}

Memberof

Workbook

Overrides

UnitModel.getSnapshot

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:137 (opens in a new tab)

getStyles()

getStyles(): Styles

Returns

Styles

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:197 (opens in a new tab)

getUnhiddenWorksheets()

getUnhiddenWorksheets(): string[]

Returns

string[]

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:342 (opens in a new tab)

getUnitId()

getUnitId(): string

Returns

string

Overrides

UnitModel.getUnitId

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:151 (opens in a new tab)

getWorksheets()

getWorksheets(): Map<string, Worksheet>

Returns

Map<string, Worksheet>

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:189 (opens in a new tab)

incrementRev()

incrementRev(): void

Increment the current revision.

Returns

void

Overrides

UnitModel.incrementRev

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:159 (opens in a new tab)

load()

load(config): void

Parameters

Parameter	Type
`config`	`IWorkbookData`

Returns

void

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:348 (opens in a new tab)

removeSheet()

removeSheet(sheetId): boolean

Parameters

Parameter	Type
`sheetId`	`string`

Returns

boolean

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:260 (opens in a new tab)

save()

save(): IWorkbookData

Create a clone of the current snapshot. Call resourceLoaderService.saveWorkbook to save the data associated with the current plugin if needed.

Returns

IWorkbookData

Memberof

Workbook

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:127 (opens in a new tab)

setActiveSheet()

setActiveSheet(worksheet): void

ActiveSheet should not be null! There is at least one sheet in a workbook. You can not delete all sheets in a workbook.

Parameters

Parameter	Type
`worksheet`	`Worksheet`

Returns

void

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:256 (opens in a new tab)

setName()

setName(name): void

Parameters

Parameter	Type
`name`	`string`

Returns

void

Overrides

UnitModel.setName

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:146 (opens in a new tab)

setRev()

setRev(rev): void

Set revision of the current snapshot.

Parameters

Parameter	Type
`rev`	`number`

Returns

void

Overrides

UnitModel.setRev

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:163 (opens in a new tab)

uniqueSheetName()

uniqueSheetName(name): string

Check whether the sheet name is unique and generate a new unique sheet name

Parameters

Parameter	Type	Default value	Description
`name`	`string`	`'Sheet1'`	sheet name

Returns

string

Unique sheet name

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:368 (opens in a new tab)

isIRangeType()

static isIRangeType(range): boolean

Parameters

Parameter	Type
`range`	`IRangeType` \| `IRangeType`[]

Returns

boolean

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:80 (opens in a new tab)

Usermanagerservice Worksheet