Class: EditorService

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`

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`Disposable`.`_disposed`	packages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
`blur$`	`readonly`	`Observable`<`unknown`>	`undefined`	-	packages/docs-ui/src/services/editor/editor-manager.service.ts:150 (opens in a new tab)
`closeRangePrompt$`	`readonly`	`Observable`<`unknown`>	`undefined`	-	packages/docs-ui/src/services/editor/editor-manager.service.ts:147 (opens in a new tab)
`focus$`	`readonly`	`Observable`<`ISuccinctDocRangeParam`>	`undefined`	-	packages/docs-ui/src/services/editor/editor-manager.service.ts:153 (opens in a new tab)
`focusStyle$`	`readonly`	`Observable`<`Nullable`<`string`>>	`undefined`	-	packages/docs-ui/src/services/editor/editor-manager.service.ts:162 (opens in a new tab)
`inputFormula$`	`readonly`	`Observable`<`IEditorInputFormulaParam`>	`undefined`	-	packages/docs-ui/src/services/editor/editor-manager.service.ts:141 (opens in a new tab)
`resize$`	`readonly`	`Observable`<`string`>	`undefined`	-	packages/docs-ui/src/services/editor/editor-manager.service.ts:144 (opens in a new tab)
`setValue$`	`readonly`	`Observable`<`IEditorSetValueParam`>	`undefined`	-	packages/docs-ui/src/services/editor/editor-manager.service.ts:156 (opens in a new tab)
`singleSelection$`	`readonly`	`Observable`<`boolean`>	`undefined`	-	packages/docs-ui/src/services/editor/editor-manager.service.ts:165 (opens in a new tab)
`state$`	`readonly`	`Observable`<`Nullable`<`IEditorStateParams`>>	`undefined`	-	packages/docs-ui/src/services/editor/editor-manager.service.ts:134 (opens in a new tab)
`valueChange$`	`readonly`	`Observable`<`Readonly`<`Editor`>>	`undefined`	-	packages/docs-ui/src/services/editor/editor-manager.service.ts:159 (opens in a new tab)

Methods

blur()

blur(): void

Returns

void

Deprecated

Implementation of

IEditorService.blur

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:320 (opens in a new tab)

changeSpreadsheetFocusState()

changeSpreadsheetFocusState(state): void

Parameters

Parameter	Type
`state`	`boolean`

Returns

void

Deprecated

Implementation of

IEditorService.changeSpreadsheetFocusState

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:257 (opens in a new tab)

checkValueLegality()

checkValueLegality(editorUnitId): boolean

Parameters

Parameter	Type
`editorUnitId`	`string`

Returns

boolean

Deprecated

Implementation of

IEditorService.checkValueLegality

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:550 (opens in a new tab)

closeRangePrompt()

closeRangePrompt(): void

Returns

void

Deprecated

Implementation of

IEditorService.closeRangePrompt

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:236 (opens in a new tab)

dispose()

dispose(): void

Returns

void

Implementation of

IDisposable.dispose

Overrides

Disposable.dispose

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:408 (opens in a new tab)

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)

focus()

focus(editorUnitId): void

Parameters

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

Returns

void

Deprecated

Implementation of

IEditorService.focus

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:339 (opens in a new tab)

focusStyle()

focusStyle(editorUnitId): undefined | false

Parameters

Parameter	Type
`editorUnitId`	`string`

Returns

undefined | false

Deprecated

Implementation of

IEditorService.focusStyle

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:267 (opens in a new tab)

getAllEditor()

getAllEditor(): Map<string, Editor>

Returns

Map<string, Editor>

Deprecated

Implementation of

IEditorService.getAllEditor

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:419 (opens in a new tab)

getEditor()

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

Parameters

Parameter	Type
`id`	`string`

Returns

Readonly<Nullable<Editor>>

Implementation of

IEditorService.getEditor

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:414 (opens in a new tab)

getFirstEditor()

getFirstEditor(): Editor

Returns

Editor

Deprecated

Implementation of

IEditorService.getFirstEditor

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:424 (opens in a new tab)

getFocusEditor()

getFocusEditor(): Readonly<Nullable<Editor>>

Returns

Readonly<Nullable<Editor>>

Deprecated

Implementation of

IEditorService.getFocusEditor

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:219 (opens in a new tab)

getFocusId()

getFocusId(): Nullable<string>

Returns

Nullable<string>

Deprecated

Implementation of

IEditorService.getFocusId

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:214 (opens in a new tab)

getOperationSheetSubUnitId()

getOperationSheetSubUnitId(): Nullable<string>

Returns

Nullable<string>

Deprecated

Implementation of

IEditorService.getOperationSheetSubUnitId

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:461 (opens in a new tab)

getOperationSheetUnitId()

getOperationSheetUnitId(): Nullable<string>

Returns

Nullable<string>

Deprecated

Implementation of

IEditorService.getOperationSheetUnitId

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:451 (opens in a new tab)

getRichValue()

getRichValue(id): undefined | IDocumentBody

Parameters

Parameter	Type
`id`	`string`

Returns

undefined | IDocumentBody

Deprecated

Implementation of

IEditorService.getRichValue

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:400 (opens in a new tab)

getSpreadsheetFocusState()

getSpreadsheetFocusState(): boolean

Returns

boolean

Deprecated

Implementation of

IEditorService.getSpreadsheetFocusState

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:262 (opens in a new tab)

getValue()

getValue(id): undefined | string

Parameters

Parameter	Type
`id`	`string`

Returns

undefined | string

Deprecated

Implementation of

IEditorService.getValue

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:385 (opens in a new tab)

isEditor()

isEditor(editorUnitId): boolean

Parameters

Parameter	Type
`editorUnitId`	`string`

Returns

boolean

Implementation of

IEditorService.isEditor

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:225 (opens in a new tab)

isSheetEditor()

isSheetEditor(editorUnitId): boolean

Parameters

Parameter	Type
`editorUnitId`	`string`

Returns

boolean

Deprecated

Implementation of

IEditorService.isSheetEditor

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:230 (opens in a new tab)

isVisible()

isVisible(id): undefined | boolean

Parameters

Parameter	Type
`id`	`string`

Returns

undefined | boolean

Deprecated

Implementation of

IEditorService.isVisible

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:441 (opens in a new tab)

refreshValueChange()

refreshValueChange(editorUnitId): void

Parameters

Parameter	Type
`editorUnitId`	`string`

Returns

void

Deprecated

Implementation of

IEditorService.refreshValueChange

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:545 (opens in a new tab)

register()

register(config, container): IDisposable

Parameters

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

Returns

IDisposable

Implementation of

IEditorService.register

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:465 (opens in a new tab)

resize()

resize(unitId): void

Parameters

Parameter	Type
`unitId`	`string`

Returns

void

Deprecated

Implementation of

IEditorService.resize

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:429 (opens in a new tab)

selectionChangingState()

selectionChangingState(): boolean

Returns

boolean

Deprecated

Implementation of

IEditorService.selectionChangingState

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:294 (opens in a new tab)

setFocusId()

setFocusId(id): void

Parameters

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

Returns

void

Deprecated

Implementation of

IEditorService.setFocusId

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:209 (opens in a new tab)

setFormula()

setFormula(formulaString, editorUnitId): void

Parameters

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

Returns

void

Deprecated

Implementation of

IEditorService.setFormula

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:362 (opens in a new tab)

setOperationSheetSubUnitId()

setOperationSheetSubUnitId(sheetId): void

Parameters

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

Returns

void

Deprecated

Implementation of

IEditorService.setOperationSheetSubUnitId

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:456 (opens in a new tab)

setOperationSheetUnitId()

setOperationSheetUnitId(unitId): void

Parameters

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

Returns

void

Deprecated

Implementation of

IEditorService.setOperationSheetUnitId

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:446 (opens in a new tab)

setRichValue()

setRichValue(body, editorUnitId): void

Parameters

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

Returns

void

Deprecated

Implementation of

IEditorService.setRichValue

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:394 (opens in a new tab)

setValue()

setValue(val, editorUnitId): void

Parameters

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

Returns

void

Deprecated

Implementation of

IEditorService.setValue

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:367 (opens in a new tab)

setValueNoRefresh()

setValueNoRefresh(val, editorUnitId): void

Parameters

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

Returns

void

Deprecated

Implementation of

IEditorService.setValueNoRefresh

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:373 (opens in a new tab)

singleSelection()

singleSelection(state): void

Parameters

Parameter	Type
`state`	`boolean`

Returns

void

Deprecated

Implementation of

IEditorService.singleSelection

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:289 (opens in a new tab)

Editor Nodepositionconverttocursor