@univerjs/sheets v0.5.1 • Docs

Class: FUniverSheetsMixin

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

FUniver

Constructors

new FUniverSheetsMixin()

new FUniverSheetsMixin(
   _injector, 
   _commandService, 
   _univerInstanceService): FUniverSheetsMixin

Parameters

Parameter	Type
`_injector`	`Injector`
`_commandService`	`ICommandService`
`_univerInstanceService`	`IUniverInstanceService`

Returns

FUniverSheetsMixin

Inherited from

FUniver.constructor

Defined in

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

Properties

Property	Modifier	Type	Inherited from	Defined in
`_commandService`	`readonly`	`ICommandService`	`FUniver`.`_commandService`	submodules/univer/packages/core/src/facade/f-univer.ts:45
`_injector`	`readonly`	`Injector`	`FUniver`.`_injector`	submodules/univer/packages/core/src/facade/f-univer.ts:44
`_univerInstanceService`	`readonly`	`IUniverInstanceService`	`FUniver`.`_univerInstanceService`	submodules/univer/packages/core/src/facade/f-univer.ts:46

Methods

_initialize()

_initialize(): void

Returns

void

Inherited from

FUniver._initialize

Defined in

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

createUniverSheet()

createUniverSheet(data): FWorkbook

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

Parameters

Parameter	Type	Description
`data`	`Partial`<`IWorkbookData`>	The snapshot of the spreadsheet.

Returns

FWorkbook

FWorkbook API instance.

Overrides

FUniver.createUniverSheet

Defined in

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

disposeUnit()

disposeUnit(unitId): boolean

Dispose the UniverSheet by the unitId. The UniverSheet would be unload from the application.

Parameters

Parameter	Type	Description
`unitId`	`string`	The unit id of the UniverSheet.

Returns

boolean

Whether the Univer instance is disposed successfully.

Inherited from

FUniver.disposeUnit

Defined in

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

executeCommand()

executeCommand<P, R>(
   id, 
   params?, 
options?): Promise<R>

Execute a command with the given id and parameters.

Type Parameters

Type Parameter	Default type
`P` extends `object`	`object`
`R`	`boolean`

Parameters

Parameter	Type	Description
`id`	`string`	Identifier of the command.
`params`?	`P`	Parameters of this execution.
`options`?	`IExecutionOptions`	Options of this execution.

Returns

Promise<R>

The result of the execution. It is a boolean value by default which indicates the command is executed.

Inherited from

FUniver.executeCommand

Defined in

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

getActiveWorkbook()

getActiveWorkbook(): null | FWorkbook

Get the currently focused Univer spreadsheet.

Returns

null | FWorkbook

The currently focused Univer spreadsheet.

Overrides

FUniver.getActiveWorkbook

Defined in

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

getCurrentLifecycleStage()

getCurrentLifecycleStage(): LifecycleStages

Get the current lifecycle stage.

Returns

LifecycleStages

The current lifecycle stage.

Inherited from

FUniver.getCurrentLifecycleStage

Defined in

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

getHooks()

getHooks(): FHooks

Get hooks.

Returns

FHooks

FHooks instance

Inherited from

FUniver.getHooks

Defined in

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

getPermission()

getPermission(): FPermission

Get the PermissionInstance.

Returns

FPermission

The PermissionInstance.

Overrides

FUniver.getPermission

Defined in

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

getUniverSheet()

getUniverSheet(id): null | FWorkbook

Get the spreadsheet API handler by the spreadsheet id.

Parameters

Parameter	Type	Description
`id`	`string`	The spreadsheet id.

Returns

null | FWorkbook

The spreadsheet API instance.

Inherited from

FUniver.getUniverSheet

Defined in

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

onBeforeCommandExecute()

onBeforeCommandExecute(callback): IDisposable

Parameters

Parameter	Type	Description
`callback`	`CommandListener`	The callback.

Returns

IDisposable

The disposable instance.

Inherited from

FUniver.onBeforeCommandExecute

Defined in

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

onCommandExecuted()

onCommandExecuted(callback): IDisposable

Parameters

Parameter	Type	Description
`callback`	`CommandListener`	The callback.

Returns

IDisposable

The disposable instance.

Inherited from

FUniver.onCommandExecuted

Defined in

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

redo()

redo(): Promise<boolean>

Redo an editing on the currently focused document.

Returns

Promise<boolean>

redo result

Inherited from

FUniver.redo

Defined in

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

syncExecuteCommand()

syncExecuteCommand<P, R>(
   id, 
   params?, 
   options?): R

Execute a command with the given id and parameters synchronously.

Type Parameters

Type Parameter	Default type
`P` extends `object`	`object`
`R`	`boolean`

Parameters

Parameter	Type	Description
`id`	`string`	Identifier of the command.
`params`?	`P`	Parameters of this execution.
`options`?	`IExecutionOptions`	Options of this execution.

Returns

R

The result of the execution. It is a boolean value by default which indicates the command is executed.

Inherited from

FUniver.syncExecuteCommand

Defined in

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

undo()

undo(): Promise<boolean>

Undo an editing on the currently focused document.

Returns

Promise<boolean>

undo result

Inherited from

FUniver.undo

Defined in

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

extend()

static extend(source): void

Parameters

Parameter	Type
`source`	`any`

Returns

void

Inherited from

FUniver.extend

Defined in

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

newAPI()

static newAPI(wrapped): FUniver

Create an FUniver instance, if the injector is not provided, it will create a new Univer instance.

Parameters

Parameter	Type	Description
`wrapped`	`Injector` \| `Univer`	The Univer instance or injector instance.

Returns

FUniver

The FUniver instance.

Static

Inherited from

FUniver.newAPI

Defined in

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

Fsheethooks Fworkbook