@univerjs/docs-ui v0.4.2 • Docs
Interface: IEditorService
Properties
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
Parameter | Type |
---|---|
state | boolean |
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
Parameter | Type |
---|---|
editorId | string |
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
Parameter | Type |
---|---|
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
Parameter | Type |
---|---|
editorUnitId | Nullable <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
Parameter | Type |
---|---|
id ? | string |
Returns
Defined in
packages/docs-ui/src/services/editor/editor-manager.service.ts:50 (opens in a new tab)
getFirstEditor()
getFirstEditor(): Editor
Returns
Defined in
packages/docs-ui/src/services/editor/editor-manager.service.ts:100 (opens in a new tab)
getFocusEditor()
getFocusEditor(): Readonly<Nullable<Editor>>
Returns
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
Parameter | Type |
---|---|
id | string |
Returns
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
Parameter | Type |
---|---|
id | string |
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
Parameter | Type |
---|---|
editorUnitId | string |
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
Parameter | Type |
---|---|
editorUnitId | string |
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
Parameter | Type |
---|---|
id | string |
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
Parameter | Type |
---|---|
editorId | string |
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
Parameter | Type |
---|---|
config | IEditorConfigParams |
container | HTMLDivElement |
Returns
Defined in
packages/docs-ui/src/services/editor/editor-manager.service.ts:52 (opens in a new tab)
resize()
resize(id): void
Parameters
Parameter | Type |
---|---|
id | string |
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
Parameter | Type |
---|---|
id | Nullable <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
Parameter | Type |
---|---|
formulaString | string |
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
Parameter | Type |
---|---|
sheetId | Nullable <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
Parameter | Type |
---|---|
unitId | Nullable <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
Parameter | Type |
---|---|
body | IDocumentBody |
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
Parameter | Type |
---|---|
val | string |
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
Parameter | Type |
---|---|
val | string |
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
Parameter | Type |
---|---|
state | boolean |
Returns
void
Defined in
packages/docs-ui/src/services/editor/editor-manager.service.ts:120 (opens in a new tab)