API Reference
@univerjs
@univerjs/docs
classes
Docselectionmanagerservice

@univerjs/docs v0.2.14Docs


Class: DocSelectionManagerService

This service is for text selection.

Extends

Constructors

new DocSelectionManagerService()

new DocSelectionManagerService(_commandService): DocSelectionManagerService

Parameters

ParameterType
_commandServiceICommandService

Returns

DocSelectionManagerService

Overrides

RxDisposable.constructor

Defined in

docs/src/services/doc-selection-manager.service.ts:60 (opens in a new tab)

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseRxDisposable._disposedcore/src/shared/lifecycle.ts:93 (opens in a new tab)
dispose$protectedSubject<void>undefinedRxDisposable.dispose$core/src/shared/lifecycle.ts:117 (opens in a new tab)
refreshSelection$readonlyObservable<Nullable<IRefreshSelectionParam>>undefined-docs/src/services/doc-selection-manager.service.ts:58 (opens in a new tab)
textSelection$readonlyObservable<Nullable<ITextSelectionManagerInsertParam>>undefined-docs/src/services/doc-selection-manager.service.ts:55 (opens in a new tab)

Methods

add()

add(textRanges, isEditing): void

Parameters

ParameterTypeDefault value
textRangesITextRangeWithStyle[]undefined
isEditingbooleantrue

Returns

void

Defined in

docs/src/services/doc-selection-manager.service.ts:164 (opens in a new tab)


dispose()

dispose(): void

Returns

void

Overrides

RxDisposable.dispose

Defined in

docs/src/services/doc-selection-manager.service.ts:240 (opens in a new tab)


disposeWithMe()

protected disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

RxDisposable.disposeWithMe

Defined in

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


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

RxDisposable.ensureNotDisposed

Defined in

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


getActiveRectRange()

getActiveRectRange(): Nullable<ITextRangeWithStyle>

Returns

Nullable<ITextRangeWithStyle>

Deprecated

Defined in

docs/src/services/doc-selection-manager.service.ts:153 (opens in a new tab)


getActiveTextRange()

getActiveTextRange(): Nullable<ITextRangeWithStyle>

Returns

Nullable<ITextRangeWithStyle>

Defined in

docs/src/services/doc-selection-manager.service.ts:138 (opens in a new tab)


getCurrentRectRanges()

getCurrentRectRanges(): Readonly<Nullable<IRectRangeWithStyle[]>>

Returns

Readonly<Nullable<IRectRangeWithStyle[]>>

Defined in

docs/src/services/doc-selection-manager.service.ts:115 (opens in a new tab)


getCurrentSelection()

getCurrentSelection(): Nullable<IDocSelectionManagerSearchParam>

Returns

Nullable<IDocSelectionManagerSearchParam>

Defined in

docs/src/services/doc-selection-manager.service.ts:66 (opens in a new tab)


getCurrentSelectionInfo()

getCurrentSelectionInfo(): undefined | IDocSelectionInnerParam

Returns

undefined | IDocSelectionInnerParam

Deprecated

Defined in

docs/src/services/doc-selection-manager.service.ts:74 (opens in a new tab)


getCurrentTextRanges()

getCurrentTextRanges(): Readonly<Nullable<ITextRangeWithStyle[]>>

Returns

Readonly<Nullable<ITextRangeWithStyle[]>>

Defined in

docs/src/services/doc-selection-manager.service.ts:111 (opens in a new tab)


getDocRanges()

getDocRanges(): ITextRangeWithStyle[]

Returns

ITextRangeWithStyle[]

Defined in

docs/src/services/doc-selection-manager.service.ts:119 (opens in a new tab)


refreshSelection()

refreshSelection(): void

Returns

void

Defined in

docs/src/services/doc-selection-manager.service.ts:78 (opens in a new tab)


replaceTextRanges()

replaceTextRanges(
   docRanges, 
   isEditing, 
   options?): void

Parameters

ParameterTypeDefault value
docRangesISuccinctDocRangeParam[]undefined
isEditingbooleantrue
options?objectundefined

Returns

void

Defined in

docs/src/services/doc-selection-manager.service.ts:180 (opens in a new tab)


replaceTextRangesWithNoRefresh()

replaceTextRangesWithNoRefresh(textSelectionInfo): void

Parameters

ParameterType
textSelectionInfoIDocSelectionInnerParam

Returns

void

Defined in

docs/src/services/doc-selection-manager.service.ts:199 (opens in a new tab)


setCurrentSelection()

setCurrentSelection(param): void

Parameters

ParameterType
paramIDocSelectionManagerSearchParam

Returns

void

Defined in

docs/src/services/doc-selection-manager.service.ts:87 (opens in a new tab)


setCurrentSelectionNotRefresh()

setCurrentSelectionNotRefresh(param): void

Parameters

ParameterType
paramIDocSelectionManagerSearchParam

Returns

void

Defined in

docs/src/services/doc-selection-manager.service.ts:93 (opens in a new tab)


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