@univerjs/docs-ui v0.2.14 • Docs

Class: DocSelectionRenderService

Every render module should implement this interface.

Extends

RxDisposable

Implements

IRenderModule

Constructors

new DocSelectionRenderService()

new DocSelectionRenderService(
   _context, 
   _layoutService, 
   _logService, 
   _docSkeletonManagerService): DocSelectionRenderService

Parameters

Parameter	Type
`_context`	`IRenderContext`<`DocumentDataModel`>
`_layoutService`	`ILayoutService`
`_logService`	`ILogService`
`_docSkeletonManagerService`	`DocSkeletonManagerService`

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`RxDisposable`.`_disposed`	packages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
`dispose$`	`protected`	`Subject`<`void`>	`undefined`	`RxDisposable`.`dispose$`	packages/core/src/shared/lifecycle.ts:117 (opens in a new tab)
`onBlur$`	`readonly`	`Observable`<`Nullable`<`IEditorInputConfig`>>	`undefined`	-	packages/docs-ui/src/services/selection/doc-selection-render.service.ts:68 (opens in a new tab)
`onCompositionend$`	`readonly`	`Observable`<`Nullable`<`IEditorInputConfig`>>	`undefined`	-	packages/docs-ui/src/services/selection/doc-selection-render.service.ts:53 (opens in a new tab)
`onCompositionstart$`	`readonly`	`Observable`<`Nullable`<`IEditorInputConfig`>>	`undefined`	-	packages/docs-ui/src/services/selection/doc-selection-render.service.ts:47 (opens in a new tab)
`onCompositionupdate$`	`readonly`	`Observable`<`Nullable`<`IEditorInputConfig`>>	`undefined`	-	packages/docs-ui/src/services/selection/doc-selection-render.service.ts:50 (opens in a new tab)
`onFocus$`	`readonly`	`Observable`<`Nullable`<`IEditorInputConfig`>>	`undefined`	-	packages/docs-ui/src/services/selection/doc-selection-render.service.ts:65 (opens in a new tab)
`onInput$`	`readonly`	`Observable`<`Nullable`<`IEditorInputConfig`>>	`undefined`	-	packages/docs-ui/src/services/selection/doc-selection-render.service.ts:44 (opens in a new tab)
`onInputBefore$`	`readonly`	`Observable`<`Nullable`<`IEditorInputConfig`>>	`undefined`	-	packages/docs-ui/src/services/selection/doc-selection-render.service.ts:38 (opens in a new tab)
`onKeydown$`	`readonly`	`Observable`<`Nullable`<`IEditorInputConfig`>>	`undefined`	-	packages/docs-ui/src/services/selection/doc-selection-render.service.ts:41 (opens in a new tab)
`onPaste$`	`readonly`	`Observable`<`Nullable`<`IEditorInputConfig`>>	`undefined`	-	packages/docs-ui/src/services/selection/doc-selection-render.service.ts:59 (opens in a new tab)
`onPointerDown$`	`readonly`	`Observable`<`void`>	`undefined`	-	packages/docs-ui/src/services/selection/doc-selection-render.service.ts:71 (opens in a new tab)
`onSelectionStart$`	`readonly`	`Observable`<`Nullable`<`INodePosition`>>	`undefined`	-	packages/docs-ui/src/services/selection/doc-selection-render.service.ts:56 (opens in a new tab)
`textSelectionInner$`	`readonly`	`Observable`<`Nullable`<`IDocSelectionInnerParam`>>	`undefined`	-	packages/docs-ui/src/services/selection/doc-selection-render.service.ts:62 (opens in a new tab)

Accessors

activeViewPort

get activeViewPort(): Viewport

Returns

Viewport

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:116 (opens in a new tab)

Methods

activate()

activate(
   x, 
   y, 
   force): void

Parameters

Parameter	Type	Default value
`x`	`number`	`undefined`
`y`	`number`	`undefined`
`force`	`boolean`	`false`

Returns

void

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:250 (opens in a new tab)

addDocRanges()

addDocRanges(
   ranges, 
   isEditing, 
   options?): void

Parameters

Parameter	Type	Default value
`ranges`	`ISuccinctDocRangeParam`[]	`undefined`
`isEditing`	`boolean`	`true`
`options`?	`object`	`undefined`

Returns

void

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:152 (opens in a new tab)

attachScrollEvent()

attachScrollEvent(viewport): void

Parameters

Parameter	Type
`viewport`	`Nullable`<`Viewport`>

Returns

void

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:928 (opens in a new tab)

blur()

blur(): void

Returns

void

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:272 (opens in a new tab)

blurEditor()

blurEditor(): void

Returns

void

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:281 (opens in a new tab)

deactivate()

deactivate(): void

Returns

void

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:287 (opens in a new tab)

disableSelection()

disableSelection(): void

Returns

void

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:148 (opens in a new tab)

dispose()

dispose(): void

Returns

void

Implementation of

IRenderModule.dispose

Overrides

RxDisposable.dispose

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:575 (opens in a new tab)

disposeWithMe()

protected disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

RxDisposable.disposeWithMe

Defined in

packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)

enableSelection()

enableSelection(): void

Returns

void

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:144 (opens in a new tab)

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

RxDisposable.ensureNotDisposed

Defined in

packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)

focus()

focus(): void

Returns

void

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:265 (opens in a new tab)

focusEditor()

focusEditor(): void

Returns

void

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:276 (opens in a new tab)

getActiveTextRange()

getActiveTextRange(): undefined | TextRange

Returns

undefined | TextRange

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:529 (opens in a new tab)

getSegment()

getSegment(): string

Returns

string

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:124 (opens in a new tab)

getSegmentPage()

getSegmentPage(): number

Returns

number

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:132 (opens in a new tab)

handleDblClick()

handleDblClick(evt): void

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

void

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:293 (opens in a new tab)

handleTripleClick()

handleTripleClick(evt): void

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

void

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:355 (opens in a new tab)

hasFocus()

hasFocus(): boolean

Returns

boolean

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:261 (opens in a new tab)

onPointDown()

onPointDown(evt): void

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

void

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:392 (opens in a new tab)

removeAllRanges()

removeAllRanges(): void

Returns

void

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:524 (opens in a new tab)

resetStyle()

resetStyle(): void

Returns

void

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:140 (opens in a new tab)

setCursorManually()

setCursorManually(evtOffsetX, evtOffsetY): void

Parameters

Parameter	Type
`evtOffsetX`	`number`
`evtOffsetY`	`number`

Returns

void

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:214 (opens in a new tab)

setSegment()

setSegment(id): void

Parameters

Parameter	Type
`id`	`string`

Returns

void

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:120 (opens in a new tab)

setSegmentPage()

setSegmentPage(pageIndex): void

Parameters

Parameter	Type
`pageIndex`	`number`

Returns

void

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:128 (opens in a new tab)

setStyle()

setStyle(style): void

Parameters

Parameter	Type	Default value
`style`	`ITextSelectionStyle`	`NORMAL_TEXT_SELECTION_PLUGIN_STYLE`

Returns

void

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:136 (opens in a new tab)

sync()

sync(): void

Returns

void

Defined in

packages/docs-ui/src/services/selection/doc-selection-render.service.ts:246 (opens in a new tab)

Docrendercontroller Docsrenderservice