API Reference
@univerjs
@univerjs/ui
interfaces
Ieditorservice

@univerjs/ui v0.1.17Docs


Interface: IEditorService

Properties

PropertyTypeDefined in
blur$Observable<unknown>packages/ui/src/services/editor/editor.service.ts:271 (opens in a new tab)
closeRangePrompt$Observable<unknown>packages/ui/src/services/editor/editor.service.ts:268 (opens in a new tab)
focus$Observable<ISuccinctTextRangeParam>packages/ui/src/services/editor/editor.service.ts:274 (opens in a new tab)
focusStyle$Observable<Nullable<string>>packages/ui/src/services/editor/editor.service.ts:288 (opens in a new tab)
inputFormula$Observable<IEditorInputFormulaParam>packages/ui/src/services/editor/editor.service.ts:242 (opens in a new tab)
resize$Observable<string>packages/ui/src/services/editor/editor.service.ts:246 (opens in a new tab)
setValue$Observable<IEditorSetValueParam>packages/ui/src/services/editor/editor.service.ts:277 (opens in a new tab)
singleSelection$Observable<boolean>packages/ui/src/services/editor/editor.service.ts:305 (opens in a new tab)
valueChange$Observable<Readonly<Editor>>packages/ui/src/services/editor/editor.service.ts:278 (opens in a new tab)

Methods

blur()

blur(): void

Returns

void

Defined in

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


changeSpreadsheetFocusState()

changeSpreadsheetFocusState(state): void

Parameters

ParameterType
stateboolean

Returns

void

Defined in

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


checkValueLegality()

checkValueLegality(editorId): boolean

Parameters

ParameterType
editorIdstring

Returns

boolean

Defined in

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


closeRangePrompt()

closeRangePrompt(): void

Returns

void

Defined in

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


focus()

focus(editorUnitId?): void

Parameters

ParameterType
editorUnitId?string

Returns

void

Defined in

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


focusStyle()

focusStyle(editorUnitId): void

Parameters

ParameterType
editorUnitIdNullable<string>

Returns

void

Defined in

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


getAllEditor()

getAllEditor(): Map<string, Editor>

Returns

Map<string, Editor>

Defined in

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


getEditor()

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

Parameters

ParameterType
id?string

Returns

Readonly<Nullable<Editor>>

Defined in

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


getFirstEditor()

getFirstEditor(): Editor

Returns

Editor

Defined in

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


getFocusEditor()

getFocusEditor(): Readonly<Nullable<Editor>>

Returns

Readonly<Nullable<Editor>>

Defined in

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


getFocusId()

getFocusId(): Nullable<string>

Returns

Nullable<string>

Defined in

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


getOperationSheetSubUnitId()

getOperationSheetSubUnitId(): Nullable<string>

Returns

Nullable<string>

Defined in

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


getOperationSheetUnitId()

getOperationSheetUnitId(): Nullable<string>

Returns

Nullable<string>

Defined in

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


getRichValue()

getRichValue(id): Nullable<IDocumentBody>

Parameters

ParameterType
idstring

Returns

Nullable<IDocumentBody>

Defined in

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


getSpreadsheetFocusState()

getSpreadsheetFocusState(): boolean

Returns

boolean

Defined in

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


getValue()

getValue(id): Nullable<string>

Parameters

ParameterType
idstring

Returns

Nullable<string>

Defined in

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


isEditor()

isEditor(editorUnitId): boolean

Parameters

ParameterType
editorUnitIdstring

Returns

boolean

Defined in

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


isSheetEditor()

isSheetEditor(editorUnitId): boolean

Parameters

ParameterType
editorUnitIdstring

Returns

boolean

Defined in

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


isVisible()

isVisible(id): Nullable<boolean>

Parameters

ParameterType
idstring

Returns

Nullable<boolean>

Defined in

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


refreshValueChange()

refreshValueChange(editorId): void

Parameters

ParameterType
editorIdstring

Returns

void

Defined in

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


register()

register(config, container): IDisposable

Parameters

ParameterType
configIEditorConfigParam
containerHTMLDivElement

Returns

IDisposable

Defined in

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


resize()

resize(id): void

Parameters

ParameterType
idstring

Returns

void

Defined in

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


selectionChangingState()

selectionChangingState(): boolean

Returns

boolean

Defined in

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


setFocusId()

setFocusId(id): void

Parameters

ParameterType
idNullable<string>

Returns

void

Defined in

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


setFormula()

setFormula(formulaString): void

Parameters

ParameterType
formulaStringstring

Returns

void

Defined in

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


setRichValue()

setRichValue(body, editorUnitId?): void

Parameters

ParameterType
bodyIDocumentBody
editorUnitId?string

Returns

void

Defined in

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


setValue()

setValue(val, editorUnitId?): void

Parameters

ParameterType
valstring
editorUnitId?string

Returns

void

Defined in

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


setValueNoRefresh()

setValueNoRefresh(val, editorUnitId?): void

Parameters

ParameterType
valstring
editorUnitId?string

Returns

void

Defined in

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


singleSelection()

singleSelection(state): void

Parameters

ParameterType
stateboolean

Returns

void

Defined in

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


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