@univerjs/ui v0.5.1 • Docs

Class: FUniverUIMixin

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

Implements

• IFUniverUIMixin

Constructors

new FUniverUIMixin()

new FUniverUIMixin(
   _injector, 
   _commandService, 
   _univerInstanceService): FUniverUIMixin

Parameters

Returns

FUniverUIMixin

Inherited from

FUniver.constructor

Defined in

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

Properties

Methods

_initialize()

_initialize(): void

Returns

void

Inherited from

FUniver._initialize

Defined in

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

copy()

copy(): Promise<boolean>

Returns

Promise<boolean>

Implementation of

IFUniverUIMixin.copy

Overrides

FUniver.copy

Defined in

submodules/univer/packages/ui/src/facade/f-univer.ts:49

disposeUnit()

disposeUnit(unitId): boolean

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

Parameters

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

Parameters

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

getComponentManager()

getComponentManager(): ComponentManager

Get the component manager

Returns

ComponentManager

The component manager

Implementation of

IFUniverUIMixin.getComponentManager

Overrides

FUniver.getComponentManager

Defined in

submodules/univer/packages/ui/src/facade/f-univer.ts:73

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

onBeforeCommandExecute()

onBeforeCommandExecute(callback): IDisposable

Register a callback that will be triggered before invoking a command.

Parameters

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

Register a callback that will be triggered when a command is invoked.

Parameters

Returns

IDisposable

The disposable instance.

Inherited from

FUniver.onCommandExecuted

Defined in

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

openDialog()

openDialog(dialog): IDisposable

Open a dialog.

Parameters

Returns

IDisposable

the disposable object

Implementation of

IFUniverUIMixin.openDialog

Overrides

FUniver.openDialog

Defined in

submodules/univer/packages/ui/src/facade/f-univer.ts:62

openSiderbar()

openSiderbar(params): IDisposable

Open a sidebar.

Parameters

Returns

IDisposable

the disposable object

Implementation of

IFUniverUIMixin.openSiderbar

Overrides

FUniver.openSiderbar

Defined in

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

paste()

paste(): Promise<boolean>

Returns

Promise<boolean>

Implementation of

IFUniverUIMixin.paste

Overrides

FUniver.paste

Defined in

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

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

Parameters

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

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

Returns

FUniver

• The FUniver instance.

Static

Inherited from

FUniver.newAPI

Defined in

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