@univerjs/docs v0.2.14 • Docs
Class: DocSelectionManagerService
This service is for text selection.
Extends
Constructors
new DocSelectionManagerService()
new DocSelectionManagerService(_commandService): DocSelectionManagerService
Parameters
Parameter | Type |
---|---|
_commandService | ICommandService |
Returns
Overrides
Defined in
docs/src/services/doc-selection-manager.service.ts:60 (opens in a new tab)
Properties
Property | Modifier | Type | Default value | Inherited from | Defined in |
---|---|---|---|---|---|
_disposed | protected | boolean | false | RxDisposable ._disposed | core/src/shared/lifecycle.ts:93 (opens in a new tab) |
dispose$ | protected | Subject <void > | undefined | RxDisposable .dispose$ | core/src/shared/lifecycle.ts:117 (opens in a new tab) |
refreshSelection$ | readonly | Observable <Nullable <IRefreshSelectionParam >> | undefined | - | docs/src/services/doc-selection-manager.service.ts:58 (opens in a new tab) |
textSelection$ | readonly | Observable <Nullable <ITextSelectionManagerInsertParam >> | undefined | - | docs/src/services/doc-selection-manager.service.ts:55 (opens in a new tab) |
Methods
add()
add(textRanges, isEditing): void
Parameters
Parameter | Type | Default value |
---|---|---|
textRanges | ITextRangeWithStyle [] | undefined |
isEditing | boolean | true |
Returns
void
Defined in
docs/src/services/doc-selection-manager.service.ts:164 (opens in a new tab)
dispose()
dispose(): void
Returns
void
Overrides
Defined in
docs/src/services/doc-selection-manager.service.ts:240 (opens in a new tab)
disposeWithMe()
protected disposeWithMe(disposable): IDisposable
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
Inherited from
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
Deprecated
Defined in
docs/src/services/doc-selection-manager.service.ts:153 (opens in a new tab)
getActiveTextRange()
getActiveTextRange(): Nullable<ITextRangeWithStyle>
Returns
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
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
Parameter | Type | Default value |
---|---|---|
docRanges | ISuccinctDocRangeParam [] | undefined |
isEditing | boolean | true |
options ? | object | undefined |
Returns
void
Defined in
docs/src/services/doc-selection-manager.service.ts:180 (opens in a new tab)
replaceTextRangesWithNoRefresh()
replaceTextRangesWithNoRefresh(textSelectionInfo): void
Parameters
Parameter | Type |
---|---|
textSelectionInfo | IDocSelectionInnerParam |
Returns
void
Defined in
docs/src/services/doc-selection-manager.service.ts:199 (opens in a new tab)
setCurrentSelection()
setCurrentSelection(param): void
Parameters
Parameter | Type |
---|---|
param | IDocSelectionManagerSearchParam |
Returns
void
Defined in
docs/src/services/doc-selection-manager.service.ts:87 (opens in a new tab)
setCurrentSelectionNotRefresh()
setCurrentSelectionNotRefresh(param): void
Parameters
Parameter | Type |
---|---|
param | IDocSelectionManagerSearchParam |
Returns
void
Defined in
docs/src/services/doc-selection-manager.service.ts:93 (opens in a new tab)