Class: EditorService

Extends

Disposable

Implements

IEditorService
IDisposable

Constructors

new EditorService()

new EditorService(
   _univerInstanceService, 
   _renderManagerService, 
   _lexerTreeBuilder, 
   _contextService): EditorService

Parameters

Parameter	Type
`_univerInstanceService`	`IUniverInstanceService`
`_renderManagerService`	`IRenderManagerService`
`_lexerTreeBuilder`	`LexerTreeBuilder`
`_contextService`	`IContextService`

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/ui/src/services/editor/editor.service.ts:336 (opens in a new tab)
`closeRangePrompt$`	`readonly`	`Observable`<`unknown`>	`undefined`	-	packages/ui/src/services/editor/editor.service.ts:333 (opens in a new tab)
`focus$`	`readonly`	`Observable`<`ISuccinctTextRangeParam`>	`undefined`	-	packages/ui/src/services/editor/editor.service.ts:339 (opens in a new tab)
`focusStyle$`	`readonly`	`Observable`<`Nullable`<`string`>>	`undefined`	-	packages/ui/src/services/editor/editor.service.ts:348 (opens in a new tab)
`inputFormula$`	`readonly`	`Observable`<`IEditorInputFormulaParam`>	`undefined`	-	packages/ui/src/services/editor/editor.service.ts:327 (opens in a new tab)
`resize$`	`readonly`	`Observable`<`string`>	`undefined`	-	packages/ui/src/services/editor/editor.service.ts:330 (opens in a new tab)
`setValue$`	`readonly`	`Observable`<`IEditorSetValueParam`>	`undefined`	-	packages/ui/src/services/editor/editor.service.ts:342 (opens in a new tab)
`singleSelection$`	`readonly`	`Observable`<`boolean`>	`undefined`	-	packages/ui/src/services/editor/editor.service.ts:351 (opens in a new tab)
`state$`	`readonly`	`Observable`<`Nullable`<`IEditorStateParam`>>	`undefined`	-	packages/ui/src/services/editor/editor.service.ts:320 (opens in a new tab)
`valueChange$`	`readonly`	`Observable`<`Readonly`<`Editor`>>	`undefined`	-	packages/ui/src/services/editor/editor.service.ts:345 (opens in a new tab)

Methods

blur()

blur(): void

Returns

void

Implementation of

IEditorService.blur

Defined in

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

changeSpreadsheetFocusState()

changeSpreadsheetFocusState(state): void

Parameters

Parameter	Type
`state`	`boolean`

Returns

void

Implementation of

IEditorService.changeSpreadsheetFocusState

Defined in

packages/ui/src/services/editor/editor.service.ts:407 (opens in a new tab)

checkValueLegality()

checkValueLegality(editorUnitId): boolean

Parameters

Parameter	Type
`editorUnitId`	`string`

Returns

boolean

Implementation of

IEditorService.checkValueLegality

Defined in

packages/ui/src/services/editor/editor.service.ts:679 (opens in a new tab)

closeRangePrompt()

closeRangePrompt(): void

Returns

void

Implementation of

IEditorService.closeRangePrompt

Defined in

packages/ui/src/services/editor/editor.service.ts:387 (opens in a new tab)

dispose()

dispose(): void

Returns

void

Implementation of

IDisposable.dispose

Overrides

Disposable.dispose

Defined in

packages/ui/src/services/editor/editor.service.ts:564 (opens in a new tab)

disposeWithMe()

protected 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`?	`string`

Returns

void

Implementation of

IEditorService.focus

Defined in

packages/ui/src/services/editor/editor.service.ts:483 (opens in a new tab)

focusStyle()

focusStyle(editorUnitId): undefined | false

Parameters

Parameter	Type
`editorUnitId`	`string`

Returns

undefined | false

Implementation of

IEditorService.focusStyle

Defined in

packages/ui/src/services/editor/editor.service.ts:415 (opens in a new tab)

getAllEditor()

getAllEditor(): Map<string, Editor>

Returns

Map<string, Editor>

Implementation of

IEditorService.getAllEditor

Defined in

packages/ui/src/services/editor/editor.service.ts:577 (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/ui/src/services/editor/editor.service.ts:570 (opens in a new tab)

getFirstEditor()

getFirstEditor(): Editor

Returns

Editor

Implementation of

IEditorService.getFirstEditor

Defined in

packages/ui/src/services/editor/editor.service.ts:581 (opens in a new tab)

getFocusEditor()

getFocusEditor(): Readonly<Nullable<Editor>>

Returns

Readonly<Nullable<Editor>>

Implementation of

IEditorService.getFocusEditor

Defined in

packages/ui/src/services/editor/editor.service.ts:372 (opens in a new tab)

getFocusId()

getFocusId(): Nullable<string>

Returns

Nullable<string>

Implementation of

IEditorService.getFocusId

Defined in

packages/ui/src/services/editor/editor.service.ts:368 (opens in a new tab)

getOperationSheetSubUnitId()

getOperationSheetSubUnitId(): Nullable<string>

Returns

Nullable<string>

Implementation of

IEditorService.getOperationSheetSubUnitId

Defined in

packages/ui/src/services/editor/editor.service.ts:612 (opens in a new tab)

getOperationSheetUnitId()

getOperationSheetUnitId(): Nullable<string>

Returns

Nullable<string>

Implementation of

IEditorService.getOperationSheetUnitId

Defined in

packages/ui/src/services/editor/editor.service.ts:604 (opens in a new tab)

getRichValue()

getRichValue(id): undefined | IDocumentBody

Parameters

Parameter	Type
`id`	`string`

Returns

undefined | IDocumentBody

Implementation of

IEditorService.getRichValue

Defined in

packages/ui/src/services/editor/editor.service.ts:556 (opens in a new tab)

getSpreadsheetFocusState()

getSpreadsheetFocusState(): boolean

Returns

boolean

Implementation of

IEditorService.getSpreadsheetFocusState

Defined in

packages/ui/src/services/editor/editor.service.ts:411 (opens in a new tab)

getValue()

getValue(id): undefined | string

Parameters

Parameter	Type
`id`	`string`

Returns

undefined | string

Implementation of

IEditorService.getValue

Defined in

packages/ui/src/services/editor/editor.service.ts:538 (opens in a new tab)

isEditor()

isEditor(editorUnitId): boolean

Parameters

Parameter	Type
`editorUnitId`	`string`

Returns

boolean

Implementation of

IEditorService.isEditor

Defined in

packages/ui/src/services/editor/editor.service.ts:378 (opens in a new tab)

isSheetEditor()

isSheetEditor(editorUnitId): boolean

Parameters

Parameter	Type
`editorUnitId`	`string`

Returns

boolean

Implementation of

IEditorService.isSheetEditor

Defined in

packages/ui/src/services/editor/editor.service.ts:382 (opens in a new tab)

isVisible()

isVisible(id): undefined | boolean

Parameters

Parameter	Type
`id`	`string`

Returns

undefined | boolean

Implementation of

IEditorService.isVisible

Defined in

packages/ui/src/services/editor/editor.service.ts:596 (opens in a new tab)

refreshValueChange()

refreshValueChange(editorUnitId): void

Parameters

Parameter	Type
`editorUnitId`	`string`

Returns

void

Implementation of

IEditorService.refreshValueChange

Defined in

packages/ui/src/services/editor/editor.service.ts:675 (opens in a new tab)

register()

register(config, container): IDisposable

Parameters

Parameter	Type
`config`	`IEditorConfigParam`
`container`	`HTMLDivElement`

Returns

IDisposable

Implementation of

IEditorService.register

Defined in

packages/ui/src/services/editor/editor.service.ts:616 (opens in a new tab)

resize()

resize(unitId): void

Parameters

Parameter	Type
`unitId`	`string`

Returns

void

Implementation of

IEditorService.resize

Defined in

packages/ui/src/services/editor/editor.service.ts:585 (opens in a new tab)

selectionChangingState()

selectionChangingState(): boolean

Returns

boolean

Implementation of

IEditorService.selectionChangingState

Defined in

packages/ui/src/services/editor/editor.service.ts:440 (opens in a new tab)

setFocusId()

setFocusId(id): void

Parameters

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

Returns

void

Implementation of

IEditorService.setFocusId

Defined in

packages/ui/src/services/editor/editor.service.ts:364 (opens in a new tab)

setFormula()

setFormula(formulaString, editorUnitId?): void

Parameters

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

Returns

void

Implementation of

IEditorService.setFormula

Defined in

packages/ui/src/services/editor/editor.service.ts:510 (opens in a new tab)

setOperationSheetSubUnitId()

setOperationSheetSubUnitId(sheetId): void

The sub-table within the sheet currently being operated on will determine whether to include subUnitId information in the ref.

Parameters

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

Returns

void

Implementation of

IEditorService.setOperationSheetSubUnitId

Defined in

packages/ui/src/services/editor/editor.service.ts:608 (opens in a new tab)

setOperationSheetUnitId()

setOperationSheetUnitId(unitId): void

The sheet currently being operated on will determine whether to include unitId information in the ref.

Parameters

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

Returns

void

Implementation of

IEditorService.setOperationSheetUnitId

Defined in

packages/ui/src/services/editor/editor.service.ts:600 (opens in a new tab)

setRichValue()

setRichValue(body, editorUnitId?): void

Parameters

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

Returns

void

Implementation of

IEditorService.setRichValue

Defined in

packages/ui/src/services/editor/editor.service.ts:546 (opens in a new tab)

setValue()

setValue(val, editorUnitId?): void

Parameters

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

Returns

void

Implementation of

IEditorService.setValue

Defined in

packages/ui/src/services/editor/editor.service.ts:517 (opens in a new tab)

setValueNoRefresh()

setValueNoRefresh(val, editorUnitId): void

Parameters

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

Returns

void

Implementation of

IEditorService.setValueNoRefresh

Defined in

packages/ui/src/services/editor/editor.service.ts:527 (opens in a new tab)

singleSelection()

singleSelection(state): void

Parameters

Parameter	Type
`state`	`boolean`

Returns

void

Implementation of

IEditorService.singleSelection

Defined in

packages/ui/src/services/editor/editor.service.ts:436 (opens in a new tab)

Desktopuicontroller Menuservice