API Reference
@univerjs
@univerjs/docs-ui
interfaces
Ieditorservice

@univerjs/docs-ui v0.3.0Docs


Interface: IEditorService

Properties

PropertyTypeDefined in
blur$Observable<unknown>packages/docs-ui/src/services/editor/editor-manager.service.ts:85 (opens in a new tab)
closeRangePrompt$Observable<unknown>packages/docs-ui/src/services/editor/editor-manager.service.ts:82 (opens in a new tab)
focus$Observable<ISuccinctDocRangeParam>packages/docs-ui/src/services/editor/editor-manager.service.ts:88 (opens in a new tab)
focusStyle$Observable<Nullable<string>>packages/docs-ui/src/services/editor/editor-manager.service.ts:102 (opens in a new tab)
inputFormula$Observable<IEditorInputFormulaParam>packages/docs-ui/src/services/editor/editor-manager.service.ts:56 (opens in a new tab)
resize$Observable<string>packages/docs-ui/src/services/editor/editor-manager.service.ts:60 (opens in a new tab)
setValue$Observable<IEditorSetValueParam>packages/docs-ui/src/services/editor/editor-manager.service.ts:91 (opens in a new tab)
singleSelection$Observable<boolean>packages/docs-ui/src/services/editor/editor-manager.service.ts:119 (opens in a new tab)
valueChange$Observable<Readonly<Editor>>packages/docs-ui/src/services/editor/editor-manager.service.ts:92 (opens in a new tab)

Methods

blur()

blur(): void

Returns

void

Defined in

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


changeSpreadsheetFocusState()

changeSpreadsheetFocusState(state): void

Parameters

ParameterType
stateboolean

Returns

void

Defined in

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


checkValueLegality()

checkValueLegality(editorId): boolean

Parameters

ParameterType
editorIdstring

Returns

boolean

Defined in

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


closeRangePrompt()

closeRangePrompt(): void

Returns

void

Defined in

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


focus()

focus(editorUnitId?): void

Parameters

ParameterType
editorUnitId?string

Returns

void

Defined in

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


focusStyle()

focusStyle(editorUnitId): void

Parameters

ParameterType
editorUnitIdNullable<string>

Returns

void

Defined in

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


getAllEditor()

getAllEditor(): Map<string, Editor>

Returns

Map<string, Editor>

Defined in

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


getEditor()

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

Parameters

ParameterType
id?string

Returns

Readonly<Nullable<Editor>>

Defined in

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


getFirstEditor()

getFirstEditor(): Editor

Returns

Editor

Defined in

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


getFocusEditor()

getFocusEditor(): Readonly<Nullable<Editor>>

Returns

Readonly<Nullable<Editor>>

Defined in

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


getFocusId()

getFocusId(): Nullable<string>

Returns

Nullable<string>

Defined in

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


getOperationSheetSubUnitId()

getOperationSheetSubUnitId(): Nullable<string>

Returns

Nullable<string>

Defined in

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


getOperationSheetUnitId()

getOperationSheetUnitId(): Nullable<string>

Returns

Nullable<string>

Defined in

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


getRichValue()

getRichValue(id): Nullable<IDocumentBody>

Parameters

ParameterType
idstring

Returns

Nullable<IDocumentBody>

Defined in

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


getSpreadsheetFocusState()

getSpreadsheetFocusState(): boolean

Returns

boolean

Defined in

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


getValue()

getValue(id): Nullable<string>

Parameters

ParameterType
idstring

Returns

Nullable<string>

Defined in

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


isEditor()

isEditor(editorUnitId): boolean

Parameters

ParameterType
editorUnitIdstring

Returns

boolean

Defined in

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


isSheetEditor()

isSheetEditor(editorUnitId): boolean

Parameters

ParameterType
editorUnitIdstring

Returns

boolean

Defined in

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


isVisible()

isVisible(id): Nullable<boolean>

Parameters

ParameterType
idstring

Returns

Nullable<boolean>

Defined in

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


refreshValueChange()

refreshValueChange(editorId): void

Parameters

ParameterType
editorIdstring

Returns

void

Defined in

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


register()

register(config, container): IDisposable

Parameters

ParameterType
configIEditorConfigParams
containerHTMLDivElement

Returns

IDisposable

Defined in

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


resize()

resize(id): void

Parameters

ParameterType
idstring

Returns

void

Defined in

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


selectionChangingState()

selectionChangingState(): boolean

Returns

boolean

Defined in

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


setFocusId()

setFocusId(id): void

Parameters

ParameterType
idNullable<string>

Returns

void

Defined in

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


setFormula()

setFormula(formulaString): void

Parameters

ParameterType
formulaStringstring

Returns

void

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:58 (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

ParameterType
sheetIdNullable<string>

Returns

void

Defined in

packages/docs-ui/src/services/editor/editor-manager.service.ts:75 (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

ParameterType
unitIdNullable<string>

Returns

void

Defined in

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


setRichValue()

setRichValue(body, editorUnitId?): void

Parameters

ParameterType
bodyIDocumentBody
editorUnitId?string

Returns

void

Defined in

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


setValue()

setValue(val, editorUnitId?): void

Parameters

ParameterType
valstring
editorUnitId?string

Returns

void

Defined in

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


setValueNoRefresh()

setValueNoRefresh(val, editorUnitId?): void

Parameters

ParameterType
valstring
editorUnitId?string

Returns

void

Defined in

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


singleSelection()

singleSelection(state): void

Parameters

ParameterType
stateboolean

Returns

void

Defined in

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


Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.