@univerjssheetsfacadeinterfacesIfuniversheetsmixin

@univerjs/sheets v0.5.1Docs


Interface: IFUniverSheetsMixin

Methods

createUniverSheet()

createUniverSheet(data): FWorkbook

Create a new spreadsheet and get the API handler of that spreadsheet.

Parameters

ParameterTypeDescription
dataPartial<IWorkbookData>The snapshot of the spreadsheet.

Returns

FWorkbook

FWorkbook API instance.

Defined in

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


getActiveWorkbook()

getActiveWorkbook(): null | FWorkbook

Get the currently focused Univer spreadsheet.

Returns

null | FWorkbook

The currently focused Univer spreadsheet.

Defined in

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


getPermission()

getPermission(): FPermission

Get the PermissionInstance.

Returns

FPermission

  • The PermissionInstance.

Defined in

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


getUniverSheet()

getUniverSheet(id): null | FWorkbook

Get the spreadsheet API handler by the spreadsheet id.

Parameters

ParameterTypeDescription
idstringThe spreadsheet id.

Returns

null | FWorkbook

The spreadsheet API instance.

Defined in

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