@univerjs/docs-ui v0.5.0-beta.1 • Docs

Class: EditorService

Deprecated

Extends

Disposable

Implements

Constructors

new EditorService()

new EditorService(
   _univerInstanceService, 
   _renderManagerService, 
   _lexerTreeBuilder, 
   _docSelectionManagerService, 
   _contextService, 
   _commandService, 
   _undoRedoService): EditorService

Parameters

Parameter	Type
`_univerInstanceService`	`IUniverInstanceService`
`_renderManagerService`	`IRenderManagerService`
`_lexerTreeBuilder`	`LexerTreeBuilder`
`_docSelectionManagerService`	`DocSelectionManagerService`
`_contextService`	`IContextService`
`_commandService`	`ICommandService`
`_undoRedoService`	`IUndoRedoService`

Returns

EditorService

Overrides

Disposable.constructor

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:232

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
~~`_disposed`~~	`protected`	`boolean`	`false`	`Disposable`.`_disposed`	submodules/univer/packages/core/src/shared/lifecycle.ts:93
~~`blur$`~~	`readonly`	`Observable`<`unknown`>	`undefined`	-	submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:213
~~`closeRangePrompt$`~~	`readonly`	`Observable`<`unknown`>	`undefined`	-	submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:210
~~`focus$`~~	`readonly`	`Observable`<`ISuccinctDocRangeParam`>	`undefined`	-	submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:216
~~`focusStyle$`~~	`readonly`	`Observable`<`Nullable`<`string`>>	`undefined`	-	submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:225
~~`inputFormula$`~~	`readonly`	`Observable`<`IEditorInputFormulaParam`>	`undefined`	-	submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:204
~~`resize$`~~	`readonly`	`Observable`<`string`>	`undefined`	-	submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:207
~~`setValue$`~~	`readonly`	`Observable`<`IEditorSetValueParam`>	`undefined`	-	submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:219
~~`singleSelection$`~~	`readonly`	`Observable`<`boolean`>	`undefined`	-	submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:228
~~`state$`~~	`readonly`	`Observable`<`Nullable`<`IEditorStateParams`>>	`undefined`	-	submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:197
~~`valueChange$`~~	`readonly`	`Observable`<`Readonly`<`Editor`>>	`undefined`	-	submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:222

Methods

blur()

blur(): void

Returns

void

Deprecated

Implementation of

IEditorService.blur

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:385

changeSpreadsheetFocusState()

changeSpreadsheetFocusState(state): void

Parameters

Parameter	Type
`state`	`boolean`

Returns

void

Deprecated

Implementation of

IEditorService.changeSpreadsheetFocusState

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:320

checkValueLegality()

checkValueLegality(editorUnitId): boolean

Parameters

Parameter	Type
`editorUnitId`	`string`

Returns

boolean

Deprecated

Implementation of

IEditorService.checkValueLegality

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:615

closeRangePrompt()

closeRangePrompt(): void

Returns

void

Deprecated

Implementation of

IEditorService.closeRangePrompt

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:299

dispose()

dispose(): void

Returns

void

Implementation of

IDisposable.dispose

Overrides

Disposable.dispose

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:473

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:96

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:100

focus()

focus(editorUnitId): void

Parameters

Parameter	Type
`editorUnitId`	`undefined` \| `string`

Returns

void

Deprecated

Implementation of

IEditorService.focus

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:404

focusStyle()

focusStyle(editorUnitId): undefined | false

Parameters

Parameter	Type
`editorUnitId`	`string`

Returns

undefined | false

Deprecated

Implementation of

IEditorService.focusStyle

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:330

getAllEditor()

getAllEditor(): Map<string, Editor>

Returns

Map<string, Editor>

Deprecated

Implementation of

IEditorService.getAllEditor

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:484

getEditor()

getEditor(id): Readonly<Nullable<Editor>>

Parameters

Parameter	Type
`id`	`string`

Returns

Readonly<Nullable<Editor>>

Implementation of

IEditorService.getEditor

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:479

getFirstEditor()

getFirstEditor(): Editor

Returns

Editor

Deprecated

Implementation of

IEditorService.getFirstEditor

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:489

getFocusEditor()

getFocusEditor(): Readonly<Nullable<Editor>>

Returns

Readonly<Nullable<Editor>>

Deprecated

Implementation of

IEditorService.getFocusEditor

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:282

getFocusId()

getFocusId(): Nullable<string>

Returns

Nullable<string>

Deprecated

Implementation of

IEditorService.getFocusId

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:277

getOperationSheetSubUnitId()

getOperationSheetSubUnitId(): Nullable<string>

Returns

Nullable<string>

Deprecated

Implementation of

IEditorService.getOperationSheetSubUnitId

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:526

getOperationSheetUnitId()

getOperationSheetUnitId(): Nullable<string>

Returns

Nullable<string>

Deprecated

Implementation of

IEditorService.getOperationSheetUnitId

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:516

getRichValue()

getRichValue(id): undefined | IDocumentBody

Parameters

Parameter	Type
`id`	`string`

Returns

undefined | IDocumentBody

Deprecated

Implementation of

IEditorService.getRichValue

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:465

getSpreadsheetFocusState()

getSpreadsheetFocusState(): boolean

Returns

boolean

Deprecated

Implementation of

IEditorService.getSpreadsheetFocusState

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:325

getValue()

getValue(id): undefined | string

Parameters

Parameter	Type
`id`	`string`

Returns

undefined | string

Deprecated

Implementation of

IEditorService.getValue

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:450

isEditor()

isEditor(editorUnitId): boolean

Parameters

Parameter	Type
`editorUnitId`	`string`

Returns

boolean

Implementation of

IEditorService.isEditor

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:288

isSheetEditor()

isSheetEditor(editorUnitId): boolean

Parameters

Parameter	Type
`editorUnitId`	`string`

Returns

boolean

Deprecated

Implementation of

IEditorService.isSheetEditor

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:293

isVisible()

isVisible(id): undefined | boolean

Parameters

Parameter	Type
`id`	`string`

Returns

undefined | boolean

Deprecated

Implementation of

IEditorService.isVisible

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:506

refreshValueChange()

refreshValueChange(editorUnitId): void

Parameters

Parameter	Type
`editorUnitId`	`string`

Returns

void

Deprecated

Implementation of

IEditorService.refreshValueChange

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:610

register()

register(config, container): IDisposable

Parameters

Parameter	Type
`config`	`IEditorConfigParams`
`container`	`HTMLDivElement`

Returns

IDisposable

Implementation of

IEditorService.register

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:530

resize()

resize(unitId): void

Parameters

Parameter	Type
`unitId`	`string`

Returns

void

Deprecated

Implementation of

IEditorService.resize

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:494

selectionChangingState()

selectionChangingState(): boolean

Returns

boolean

Deprecated

Implementation of

IEditorService.selectionChangingState

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:359

setFocusId()

setFocusId(id): void

Parameters

Parameter	Type
`id`	`Nullable`<`string`>

Returns

void

Deprecated

Implementation of

IEditorService.setFocusId

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:272

setFormula()

setFormula(formulaString, editorUnitId): void

Parameters

Parameter	Type
`formulaString`	`string`
`editorUnitId`	`string`

Returns

void

Deprecated

Implementation of

IEditorService.setFormula

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:427

setOperationSheetSubUnitId()

setOperationSheetSubUnitId(sheetId): void

Parameters

Parameter	Type
`sheetId`	`Nullable`<`string`>

Returns

void

Deprecated

Implementation of

IEditorService.setOperationSheetSubUnitId

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:521

setOperationSheetUnitId()

setOperationSheetUnitId(unitId): void

Parameters

Parameter	Type
`unitId`	`Nullable`<`string`>

Returns

void

Deprecated

Implementation of

IEditorService.setOperationSheetUnitId

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:511

setRichValue()

setRichValue(body, editorUnitId): void

Parameters

Parameter	Type
`body`	`IDocumentBody`
`editorUnitId`	`string`

Returns

void

Deprecated

Implementation of

IEditorService.setRichValue

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:459

setValue()

setValue(val, editorUnitId): void

Parameters

Parameter	Type
`val`	`string`
`editorUnitId`	`string`

Returns

void

Deprecated

Implementation of

IEditorService.setValue

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:432

setValueNoRefresh()

setValueNoRefresh(val, editorUnitId): void

Parameters

Parameter	Type
`val`	`string`
`editorUnitId`	`string`

Returns

void

Deprecated

Implementation of

IEditorService.setValueNoRefresh

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:438

singleSelection()

singleSelection(state): void

Parameters

Parameter	Type
`state`	`boolean`

Returns

void

Deprecated

Implementation of

IEditorService.singleSelection

Defined in

submodules/univer/packages/docs-ui/src/services/editor/editor-manager.service.ts:354

Editor Nodepositionconverttocursor