Class: FUniver

Constructors

new FUniver()

new FUniver(
   _injector, 
   _univerInstanceService, 
   _commandService, 
   _ws, 
   _renderManagerService): FUniver

Parameters

Parameter	Type
`_injector`	`Injector`
`_univerInstanceService`	`IUniverInstanceService`
`_commandService`	`ICommandService`
`_ws`	`ISocketService`
`_renderManagerService`	`IRenderManagerService`

Returns

FUniver

Defined in

facade.ts:94 (opens in a new tab)

Properties

Property	Modifier	Type	Default value	Defined in
`_injector`	`readonly`	`Injector`	`undefined`	facade.ts:95 (opens in a new tab)
`BorderStyle`	`static`	typeof `BorderStyleTypes`	`BorderStyleTypes`	facade.ts:86 (opens in a new tab)
`WrapStrategy`	`static`	typeof `WrapStrategy`	`WrapStrategy`	facade.ts:87 (opens in a new tab)

Methods

createSocket()

createSocket(url): ISocket

Set WebSocket URL for WebSocketService

Parameters

Parameter	Type	Description
`url`	`string`	WebSocketService URL

Returns

ISocket

WebSocket info and callback

Defined in

facade.ts:320 (opens in a new tab)

createUniverDoc()

createUniverDoc(data): FDocument

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

Parameters

Parameter	Type	Description
`data`	`Partial`<`IDocumentData`>	The snapshot of the document.

Returns

FDocument

Document API instance.

Defined in

facade.ts:119 (opens in a new tab)

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

Spreadsheet API instance.

Defined in

facade.ts:109 (opens in a new tab)

customizeColumnHeader()

customizeColumnHeader(cfg): void

customizeColumnHeader

Parameters

Parameter	Type	Description
`cfg`	`IColumnsHeaderCfgParam`	cfg example ({ headerStyle:{backgroundColor: 'pink', fontSize: 9}, columnsCfg: ['MokaII', undefined, null, {text: 'Size', textAlign: 'left'}]})

Returns

void

Defined in

facade.ts:372 (opens in a new tab)

customizeRowHeader()

customizeRowHeader(cfg): void

Parameters

Parameter	Type
`cfg`	`IRowsHeaderCfgParam`

Returns

void

Defined in

facade.ts:383 (opens in a new tab)

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 `unitId` of the UniverSheet.

Returns

boolean

If the UniverSheet is disposed successfully, return true, otherwise return false.

Defined in

facade.ts:129 (opens in a new tab)

executeCommand()

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

Execute command

Type Parameters

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

Parameters

Parameter	Type	Description
`id`	`string`	Command id
`params`?	`P`	Command params
`options`?	`IExecutionOptions`	Command options

Returns

Promise<R>

Command Promise

Defined in

facade.ts:307 (opens in a new tab)

getActiveDocument()

getActiveDocument(): null | FDocument

Get the currently focused Univer document.

Returns

null | FDocument

the currently focused Univer document.

Defined in

facade.ts:178 (opens in a new tab)

getActiveWorkbook()

getActiveWorkbook(): null | FWorkbook

Get the currently focused Univer spreadsheet.

Returns

null | FWorkbook

the currently focused Univer spreadsheet.

Defined in

facade.ts:165 (opens in a new tab)

getHooks()

getHooks(): FHooks

Get hooks

Returns

FHooks

Defined in

facade.ts:341 (opens in a new tab)

getSheetHooks()

getSheetHooks(): FSheetHooks

Get sheet hooks

Returns

FSheetHooks

Defined in

facade.ts:334 (opens in a new tab)

getUniverDoc()

getUniverDoc(id): null | FDocument

Get the document API handler by the document id.

Parameters

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

Returns

null | FDocument

Document API instance.

Defined in

facade.ts:152 (opens in a new tab)

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

Spreadsheet API instance.

Defined in

facade.ts:138 (opens in a new tab)

onBeforeCommandExecute()

onBeforeCommandExecute(callback): IDisposable

Parameters

Parameter	Type	Description
`callback`	`CommandListener`	the callback.

Returns

IDisposable

A function to dispose the listening.

Defined in

facade.ts:281 (opens in a new tab)

onCommandExecuted()

onCommandExecuted(callback): IDisposable

Parameters

Parameter	Type	Description
`callback`	`CommandListener`	the callback.

Returns

IDisposable

A function to dispose the listening.

Defined in

facade.ts:292 (opens in a new tab)

redo()

redo(): Promise<boolean>

Redo an editing on the currently focused document.

Returns

Promise<boolean>

redo result

Defined in

facade.ts:268 (opens in a new tab)

registerFunction()

registerFunction(config): IDisposable

Parameters

Parameter	Type
`config`	`IRegisterFunctionParams`

Returns

IDisposable

Defined in

facade.ts:191 (opens in a new tab)

registerSheetColumnHeaderExtension()

registerSheetColumnHeaderExtension(unitId, ...extensions): IDisposable

Parameters

Parameter	Type
`unitId`	`string`
...`extensions`	`SheetExtension`[]

Returns

IDisposable

Defined in

facade.ts:229 (opens in a new tab)

registerSheetMainExtension()

registerSheetMainExtension(unitId, ...extensions): IDisposable

Parameters

Parameter	Type
`unitId`	`string`
...`extensions`	`SheetExtension`[]

Returns

IDisposable

Defined in

facade.ts:244 (opens in a new tab)

registerSheetRowHeaderExtension()

registerSheetRowHeaderExtension(unitId, ...extensions): IDisposable

Parameters

Parameter	Type
`unitId`	`string`
...`extensions`	`SheetExtension`[]

Returns

IDisposable

Defined in

facade.ts:214 (opens in a new tab)

undo()

undo(): Promise<boolean>

Undo an editing on the currently focused document.

Returns

Promise<boolean>

redo result

Defined in

facade.ts:260 (opens in a new tab)

getDependencies()

protected static getDependencies(injector, derivedDependencies?): Dependency[]

Get dependencies for FUniver, you can override newAPI to add more dependencies.

Parameters

Parameter	Type
`injector`	`Injector`
`derivedDependencies`?	[]

Returns

Dependency[]

Defined in

facade.ts:60 (opens in a new tab)

newAPI()

static newAPI(wrapped): FUniver

Create a 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.

Returns

FUniver

FUniver instance.

Zh

创建一个 FUniver 实例，如果未提供注入器，将创建一个新的 Univer 实例。 @param_zh wrapped Univer 实例或注入器。 @returns_zh FUniver 实例。

Defined in

facade.ts:79 (opens in a new tab)

Fselection Fworkbook