API Reference
@univerjs
@univerjs/ui
classes
Editor

@univerjs/ui v0.2.14Docs


Class: Editor

Constructors

new Editor()

new Editor(_param): Editor

Parameters

ParameterType
_paramIEditorSetParam

Returns

Editor

Defined in

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

Accessors

cancelDefaultResizeListener

get cancelDefaultResizeListener(): undefined | boolean

Returns

undefined | boolean

Defined in

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


documentDataModel

get documentDataModel(): DocumentDataModel

Returns

DocumentDataModel

Defined in

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


editorUnitId

get editorUnitId(): string

Returns

string

Defined in

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


render

get render(): IRender

Returns

IRender

Defined in

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

Methods

getBody()

getBody(): undefined | IDocumentBody

Returns

undefined | IDocumentBody

Defined in

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


getBoundingClientRect()

getBoundingClientRect(): DOMRect

Returns

DOMRect

Defined in

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


getOpenForSheetSubUnitId()

getOpenForSheetSubUnitId(): Nullable<string>

Returns

Nullable<string>

Defined in

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


getOpenForSheetUnitId()

getOpenForSheetUnitId(): Nullable<string>

Returns

Nullable<string>

Defined in

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


getValue()

getValue(): string

Returns

string

Defined in

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


isFocus()

isFocus(): boolean

Returns

boolean

Defined in

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


isFormulaEditor()

isFormulaEditor(): boolean

Returns

boolean

Deprecated

Defined in

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


isReadOnly()

isReadOnly(): boolean

Returns

boolean

Defined in

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


isSheetEditor()

isSheetEditor(): boolean

Returns

boolean

Defined in

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


isSingle()

isSingle(): boolean

Returns

boolean

Defined in

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


isSingleChoice()

isSingleChoice(): boolean

Returns

boolean

Defined in

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


isValueLegality()

isValueLegality(): boolean

Returns

boolean

Defined in

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


isVisible()

isVisible(): undefined | boolean

Returns

undefined | boolean

Defined in

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


onlyInputContent()

onlyInputContent(): boolean

Returns

boolean

Defined in

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


onlyInputFormula()

onlyInputFormula(): boolean

Returns

boolean

Defined in

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


onlyInputRange()

onlyInputRange(): boolean

Returns

boolean

Defined in

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


setFocus()

setFocus(state): void

Parameters

ParameterTypeDefault value
statebooleanfalse

Returns

void

Defined in

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


setOpenForSheetSubUnitId()

setOpenForSheetSubUnitId(subUnitId): void

Parameters

ParameterType
subUnitIdNullable<string>

Returns

void

Defined in

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


setOpenForSheetUnitId()

setOpenForSheetUnitId(unitId): void

Parameters

ParameterType
unitIdNullable<string>

Returns

void

Defined in

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


setValueLegality()

setValueLegality(state): void

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

void

Defined in

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


update()

update(param): void

Parameters

ParameterType
paramPartial<IEditorSetParam>

Returns

void

Defined in

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


updateCanvasStyle()

updateCanvasStyle(): void

Returns

void

Defined in

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


verticalAlign()

verticalAlign(): void

Returns

void

Defined in

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


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