@univerjs/docs-ui v0.3.0 • Docs
Class: Editor
Extends
Implements
IEditor
Constructors
new Editor()
new Editor(
_param,
_univerInstanceService,
_docSelectionManagerService,
_commandService,
_undoRedoService): Editor
Parameters
Parameter | Type |
---|---|
_param | IEditorOptions |
_univerInstanceService | IUniverInstanceService |
_docSelectionManagerService | DocSelectionManagerService |
_commandService | ICommandService |
_undoRedoService | IUndoRedoService |
Returns
Overrides
Defined in
packages/docs-ui/src/services/editor/editor.ts:173 (opens in a new tab)
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$ | public | Observable <IEditorInputConfig > | undefined | - | packages/docs-ui/src/services/editor/editor.ts:161 (opens in a new tab) |
change$ | public | Observable <IEditorEvent > | undefined | - | packages/docs-ui/src/services/editor/editor.ts:144 (opens in a new tab) |
focus$ | public | Observable <IEditorInputConfig > | undefined | - | packages/docs-ui/src/services/editor/editor.ts:157 (opens in a new tab) |
input$ | public | Observable <IEditorInputEvent > | undefined | - | packages/docs-ui/src/services/editor/editor.ts:148 (opens in a new tab) |
paste$ | public | Observable <IEditorInputConfig > | undefined | - | packages/docs-ui/src/services/editor/editor.ts:152 (opens in a new tab) |
selectionChange$ | public | Observable <IDocSelectionInnerParam > | undefined | - | packages/docs-ui/src/services/editor/editor.ts:165 (opens in a new tab) |
Accessors
cancelDefaultResizeListener
get cancelDefaultResizeListener(): undefined | boolean
Returns
undefined
| boolean
Defined in
packages/docs-ui/src/services/editor/editor.ts:375 (opens in a new tab)
documentDataModel
get documentDataModel(): DocumentDataModel
Deprecated
use getDocumentData.
Returns
Defined in
packages/docs-ui/src/services/editor/editor.ts:364 (opens in a new tab)
editorUnitId
get editorUnitId(): string
Deprecated
use getEditorId.
Returns
string
Defined in
packages/docs-ui/src/services/editor/editor.ts:371 (opens in a new tab)
render
get render(): IRender
Returns
Defined in
packages/docs-ui/src/services/editor/editor.ts:379 (opens in a new tab)
Methods
blur()
blur(): void
Returns
void
Implementation of
IEditor.blur
Defined in
packages/docs-ui/src/services/editor/editor.ts:284 (opens in a new tab)
clearUndoRedoHistory()
clearUndoRedoHistory(): void
Returns
void
Implementation of
IEditor.clearUndoRedoHistory
Defined in
packages/docs-ui/src/services/editor/editor.ts:355 (opens in a new tab)
dispose()
dispose(): void
Returns
void
Inherited from
Defined in
packages/core/src/shared/lifecycle.ts:106 (opens in a new tab)
disposeWithMe()
protected disposeWithMe(disposable): IDisposable
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
Inherited from
Defined in
packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)
ensureNotDisposed()
protected ensureNotDisposed(): void
Returns
void
Inherited from
Defined in
packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)
focus()
focus(): void
Returns
void
Implementation of
IEditor.focus
Defined in
packages/docs-ui/src/services/editor/editor.ts:256 (opens in a new tab)
getBody()
getBody(): undefined | IDocumentBody
Returns
undefined
| IDocumentBody
Deprecated
use getDocumentData.
Defined in
packages/docs-ui/src/services/editor/editor.ts:479 (opens in a new tab)
getBoundingClientRect()
getBoundingClientRect(): DOMRect
Returns
DOMRect
Defined in
packages/docs-ui/src/services/editor/editor.ts:450 (opens in a new tab)
getDocumentData()
getDocumentData(): IDocumentData
Returns
Implementation of
IEditor.getDocumentData
Defined in
packages/docs-ui/src/services/editor/editor.ts:331 (opens in a new tab)
getEditorId()
getEditorId(): string
Returns
string
Implementation of
IEditor.getEditorId
Defined in
packages/docs-ui/src/services/editor/editor.ts:326 (opens in a new tab)
getOpenForSheetSubUnitId()
getOpenForSheetSubUnitId(): Nullable<string>
Returns
Nullable
<string
>
Deprecated
Defined in
packages/docs-ui/src/services/editor/editor.ts:403 (opens in a new tab)
getOpenForSheetUnitId()
getOpenForSheetUnitId(): Nullable<string>
Returns
Nullable
<string
>
Deprecated
Defined in
packages/docs-ui/src/services/editor/editor.ts:393 (opens in a new tab)
getSelectionRanges()
getSelectionRanges(): ITextRangeWithStyle[]
Returns
Implementation of
IEditor.getSelectionRanges
Defined in
packages/docs-ui/src/services/editor/editor.ts:315 (opens in a new tab)
getValue()
getValue(): string
Returns
string
Deprecated
use getDocumentData.
Defined in
packages/docs-ui/src/services/editor/editor.ts:471 (opens in a new tab)
isFocus()
isFocus(): boolean
Returns
boolean
Implementation of
IEditor.isFocus
Defined in
packages/docs-ui/src/services/editor/editor.ts:417 (opens in a new tab)
isFormulaEditor()
isFormulaEditor(): boolean
Returns
boolean
Deprecated
Defined in
packages/docs-ui/src/services/editor/editor.ts:464 (opens in a new tab)
isReadOnly()
isReadOnly(): boolean
Returns
boolean
Defined in
packages/docs-ui/src/services/editor/editor.ts:431 (opens in a new tab)
isSheetEditor()
isSheetEditor(): boolean
Returns
boolean
Deprecated
Defined in
packages/docs-ui/src/services/editor/editor.ts:459 (opens in a new tab)
isSingle()
isSingle(): boolean
Returns
boolean
Deprecated
Defined in
packages/docs-ui/src/services/editor/editor.ts:427 (opens in a new tab)
isSingleChoice()
isSingleChoice(): boolean
Returns
boolean
Defined in
packages/docs-ui/src/services/editor/editor.ts:383 (opens in a new tab)
isValueLegality()
isValueLegality(): boolean
Returns
boolean
Deprecated
Defined in
packages/docs-ui/src/services/editor/editor.ts:408 (opens in a new tab)
isVisible()
isVisible(): undefined | boolean
Returns
undefined
| boolean
Defined in
packages/docs-ui/src/services/editor/editor.ts:454 (opens in a new tab)
onlyInputContent()
onlyInputContent(): boolean
Returns
boolean
Deprecated
Defined in
packages/docs-ui/src/services/editor/editor.ts:436 (opens in a new tab)
onlyInputFormula()
onlyInputFormula(): boolean
Returns
boolean
Deprecated
Defined in
packages/docs-ui/src/services/editor/editor.ts:441 (opens in a new tab)
onlyInputRange()
onlyInputRange(): boolean
Returns
boolean
Deprecated
Defined in
packages/docs-ui/src/services/editor/editor.ts:446 (opens in a new tab)
select()
select(): void
Returns
void
Implementation of
IEditor.select
Defined in
packages/docs-ui/src/services/editor/editor.ts:294 (opens in a new tab)
setDocumentData()
setDocumentData(data, textRanges): void
Parameters
Parameter | Type |
---|---|
data | IDocumentData |
textRanges | Nullable <ITextRangeWithStyle []> |
Returns
void
Implementation of
IEditor.setDocumentData
Defined in
packages/docs-ui/src/services/editor/editor.ts:339 (opens in a new tab)
setFocus()
setFocus(state): void
Parameters
Parameter | Type | Default value |
---|---|---|
state | boolean | false |
Returns
void
Deprecated
Defined in
packages/docs-ui/src/services/editor/editor.ts:422 (opens in a new tab)
setOpenForSheetSubUnitId()
setOpenForSheetSubUnitId(subUnitId): void
Parameters
Parameter | Type |
---|---|
subUnitId | Nullable <string > |
Returns
void
Deprecated
Defined in
packages/docs-ui/src/services/editor/editor.ts:398 (opens in a new tab)
setOpenForSheetUnitId()
setOpenForSheetUnitId(unitId): void
Parameters
Parameter | Type |
---|---|
unitId | Nullable <string > |
Returns
void
Deprecated
Defined in
packages/docs-ui/src/services/editor/editor.ts:388 (opens in a new tab)
setSelectionRanges()
setSelectionRanges(ranges): void
Parameters
Parameter | Type |
---|---|
ranges | ISuccinctDocRangeParam [] |
Returns
void
Implementation of
IEditor.setSelectionRanges
Defined in
packages/docs-ui/src/services/editor/editor.ts:304 (opens in a new tab)
setValueLegality()
setValueLegality(state): void
Parameters
Parameter | Type | Default value |
---|---|---|
state | boolean | true |
Returns
void
Deprecated
Defined in
packages/docs-ui/src/services/editor/editor.ts:413 (opens in a new tab)
update()
update(param): void
@deprecated.
Parameters
Parameter | Type |
---|---|
param | Partial <IEditorOptions > |
Returns
void
Defined in
packages/docs-ui/src/services/editor/editor.ts:486 (opens in a new tab)
updateCanvasStyle()
updateCanvasStyle(): void
Returns
void
Defined in
packages/docs-ui/src/services/editor/editor.ts:526 (opens in a new tab)
verticalAlign()
verticalAlign(): void
Returns
void
Defined in
packages/docs-ui/src/services/editor/editor.ts:493 (opens in a new tab)