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:52 (opens in a new tab)
`name$`	`readonly`	`Observable`<`string`>	`undefined`	-	-	submodules/univer/packages/core/src/sheets/workbook.ts:79 (opens in a new tab)
`sheetCreated$`	`readonly`	`Observable`<`Worksheet`>	`undefined`	-	-	submodules/univer/packages/core/src/sheets/workbook.ts:45 (opens in a new tab)
`sheetDisposed$`	`readonly`	`Observable`<`Worksheet`>	`undefined`	-	-	submodules/univer/packages/core/src/sheets/workbook.ts:48 (opens in a new tab)
`type`	`public`	`UNIVER_SHEET`	`UniverInstanceType.UNIVER_SHEET`	`UnitModel`.`type`	-	submodules/univer/packages/core/src/sheets/workbook.ts:42 (opens in a new tab)

Accessors

name

get name(): string

Returns

string

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:80 (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:167 (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:347 (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()

protected 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:219 (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:371 (opens in a new tab)

getActiveSheet()

getActiveSheet(): Nullable<Worksheet>

Get the active sheet

Returns

Nullable<Worksheet>

Defined in

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

getActiveSheetIndex()

getActiveSheetIndex(): number

Returns

number

Defined in

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

getActiveSpreadsheet()

getActiveSpreadsheet(): Workbook

Returns

Workbook

Defined in

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

getConfig()

getConfig(): IWorkbookData

Returns

IWorkbookData

Defined in

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

getContainer()

getContainer(): undefined | string

Returns

undefined | string

Defined in

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

getHiddenWorksheets()

getHiddenWorksheets(): string[]

Returns

string[]

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:325 (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:202 (opens in a new tab)

getName()

getName(): string

Returns

string

Defined in

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

getRev()

getRev(): number

Returns

number

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:147 (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:320 (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:316 (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:307 (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:296 (opens in a new tab)

getSheetOrders()

getSheetOrders(): readonly string[]

Returns

readonly string[]

Defined in

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

getSheetSize()

getSheetSize(): number

Returns

number

Defined in

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

getSheets()

getSheets(): Worksheet[]

Returns

Worksheet[]

Defined in

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

getSheetsName()

getSheetsName(): string[]

Returns

string[]

Defined in

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

getShouldRenderLoopImmediately()

getShouldRenderLoopImmediately(): boolean

Returns

boolean

Defined in

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

getSnapshot()

getSnapshot(): IWorkbookData

Returns

IWorkbookData

Defined in

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

getStyles()

getStyles(): Styles

Returns

Styles

Defined in

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

getUnhiddenWorksheets()

getUnhiddenWorksheets(): string[]

Returns

string[]

Defined in

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

getUnitId()

getUnitId(): string

Returns

string

Overrides

UnitModel.getUnitId

Defined in

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

getWorksheets()

getWorksheets(): Map<string, Worksheet>

Returns

Map<string, Worksheet>

Defined in

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

incrementRev()

incrementRev(): void

Returns

void

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:151 (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:337 (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:245 (opens in a new tab)

save()

save(): IWorkbookData

Returns

IWorkbookData

Defined in

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

setActiveSheet()

setActiveSheet(worksheet): void

Parameters

Parameter	Type
`worksheet`	`Nullable`<`Worksheet`>

Returns

void

Defined in

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

setName()

setName(name): void

Parameters

Parameter	Type
`name`	`string`

Returns

void

Defined in

submodules/univer/packages/core/src/sheets/workbook.ts:138 (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:357 (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:126 (opens in a new tab)

Valueiterator Worksheet