@univerjs/sheets v0.1.17 • Docs
Class: SelectionManagerService
This service is responsible for managing the selection data.
You can generally modify its data through SetSelectionsOperation.
In the same app and sub-table, there will be different functional selection areas, such as charts, formulas, conditional formats, etc., which are distinguished by the pluginName.
The selection data drawn by the user through the SelectionRenderService will be saved to this service.
Data changes within the service will also notify the SelectionController to redraw the selection area.
Not only will switching sub-tables trigger a redraw, but also changing row and column widths, hiding rows and columns, automatic row height, dragging rows and columns, deleting rows and columns, and so on, will cause the size of the selection area to change.
Implements
IDisposable
Constructors
new SelectionManagerService()
new SelectionManagerService(_themeService): SelectionManagerService
Parameters
Parameter | Type |
---|---|
_themeService | ThemeService |
Returns
Defined in
packages/sheets/src/services/selection-manager.service.ts:81 (opens in a new tab)
Properties
Property | Modifier | Type | Defined in |
---|---|---|---|
selectionMoveEnd$ | readonly | Observable <Nullable <ISelectionWithStyle []>> | packages/sheets/src/services/selection-manager.service.ts:73 (opens in a new tab) |
selectionMoveEndBefore$ | readonly | Observable <Nullable <ISelectionWithStyle []>> | packages/sheets/src/services/selection-manager.service.ts:76 (opens in a new tab) |
selectionMoveStart$ | readonly | Observable <Nullable <ISelectionWithStyle []>> | packages/sheets/src/services/selection-manager.service.ts:67 (opens in a new tab) |
selectionMoving$ | readonly | Observable <Nullable <ISelectionWithStyle []>> | packages/sheets/src/services/selection-manager.service.ts:70 (opens in a new tab) |
Methods
add()
add(selectionDatas): void
Parameters
Parameter | Type |
---|---|
selectionDatas | ISelectionWithStyle [] |
Returns
void
Defined in
packages/sheets/src/services/selection-manager.service.ts:227 (opens in a new tab)
addNoRefresh()
addNoRefresh(selectionDatas): void
Parameters
Parameter | Type |
---|---|
selectionDatas | ISelectionWithStyle [] |
Returns
void
Defined in
packages/sheets/src/services/selection-manager.service.ts:214 (opens in a new tab)
changePlugin()
changePlugin(pluginName): void
Parameters
Parameter | Type |
---|---|
pluginName | string |
Returns
void
Defined in
packages/sheets/src/services/selection-manager.service.ts:96 (opens in a new tab)
changePluginNoRefresh()
changePluginNoRefresh(pluginName): void
Parameters
Parameter | Type |
---|---|
pluginName | string |
Returns
void
Defined in
packages/sheets/src/services/selection-manager.service.ts:109 (opens in a new tab)
clear()
clear(): void
Returns
void
Defined in
packages/sheets/src/services/selection-manager.service.ts:267 (opens in a new tab)
createCopyPasteSelection()
createCopyPasteSelection(): ISelectionStyle
Returns
Defined in
packages/sheets/src/services/selection-manager.service.ts:292 (opens in a new tab)
createDefaultAutoFillSelection()
createDefaultAutoFillSelection(): ISelectionStyle
Returns
Defined in
packages/sheets/src/services/selection-manager.service.ts:282 (opens in a new tab)
createDefaultSelection()
createDefaultSelection(): ISelectionStyle
Returns
Defined in
packages/sheets/src/services/selection-manager.service.ts:303 (opens in a new tab)
dispose()
dispose(): void
Returns
void
Implementation of
IDisposable.dispose
Defined in
packages/sheets/src/services/selection-manager.service.ts:151 (opens in a new tab)
getCurrent()
getCurrent(): Nullable<ISelectionManagerSearchParam>
Returns
Nullable
<ISelectionManagerSearchParam
>
Defined in
packages/sheets/src/services/selection-manager.service.ts:85 (opens in a new tab)
getFirst()
getFirst(): Readonly<Nullable<ISelectionWithStyle>>
Returns
Readonly
<Nullable
<ISelectionWithStyle
>>
Defined in
packages/sheets/src/services/selection-manager.service.ts:203 (opens in a new tab)
getLast()
getLast(): Readonly<Nullable<ISelectionWithStyle & {
primary: ISelectionCell;
}>>
Returns
Readonly
<Nullable
<ISelectionWithStyle
& {
primary
: ISelectionCell
;
}>>
Defined in
packages/sheets/src/services/selection-manager.service.ts:207 (opens in a new tab)
getLastByPlugin()
getLastByPlugin(pluginName): Readonly<Nullable<ISelectionWithStyle>>
Parameters
Parameter | Type |
---|---|
pluginName | string |
Returns
Readonly
<Nullable
<ISelectionWithStyle
>>
Defined in
packages/sheets/src/services/selection-manager.service.ts:89 (opens in a new tab)
getSelectionDatasByParam()
getSelectionDatasByParam(param): Readonly<Nullable<ISelectionWithStyle[]>>
Parameters
Parameter | Type |
---|---|
param | Nullable <ISelectionManagerSearchParam > |
Returns
Readonly
<Nullable
<ISelectionWithStyle
[]>>
Defined in
packages/sheets/src/services/selection-manager.service.ts:186 (opens in a new tab)
getSelectionInfo()
getSelectionInfo(): Readonly<ISelectionInfo>
Returns
Readonly
<ISelectionInfo
>
Defined in
packages/sheets/src/services/selection-manager.service.ts:182 (opens in a new tab)
getSelectionRanges()
getSelectionRanges(): Nullable<IRange[]>
Returns
Defined in
packages/sheets/src/services/selection-manager.service.ts:194 (opens in a new tab)
getSelections()
getSelections(): Readonly<Nullable<ISelectionWithStyle[]>>
Returns
Readonly
<Nullable
<ISelectionWithStyle
[]>>
Defined in
packages/sheets/src/services/selection-manager.service.ts:190 (opens in a new tab)
isOverlapping()
isOverlapping(): boolean
Determine whether multiple current selections overlap
Returns
boolean
Defined in
packages/sheets/src/services/selection-manager.service.ts:316 (opens in a new tab)
makeDirty()
makeDirty(dirty): void
Parameters
Parameter | Type | Default value |
---|---|---|
dirty | boolean | true |
Returns
void
Defined in
packages/sheets/src/services/selection-manager.service.ts:157 (opens in a new tab)
refreshSelection()
refreshSelection(): void
Returns
void
Defined in
packages/sheets/src/services/selection-manager.service.ts:161 (opens in a new tab)
remove()
remove(index): void
Parameters
Parameter | Type |
---|---|
index | number |
Returns
void
Defined in
packages/sheets/src/services/selection-manager.service.ts:274 (opens in a new tab)
replace()
replace(selectionDatas, type): void
Parameters
Parameter | Type | Default value |
---|---|---|
selectionDatas | ISelectionWithStyle [] | undefined |
type | SelectionMoveType | SelectionMoveType.MOVE_END |
Returns
void
Defined in
packages/sheets/src/services/selection-manager.service.ts:238 (opens in a new tab)
replaceWithNoRefresh()
replaceWithNoRefresh(selectionDatas): void
Parameters
Parameter | Type |
---|---|
selectionDatas | ISelectionWithStyle [] |
Returns
void
Defined in
packages/sheets/src/services/selection-manager.service.ts:257 (opens in a new tab)
reset()
reset(): void
Returns
void
Defined in
packages/sheets/src/services/selection-manager.service.ts:128 (opens in a new tab)
resetPlugin()
resetPlugin(): void
Returns
void
Defined in
packages/sheets/src/services/selection-manager.service.ts:142 (opens in a new tab)
setCurrentSelection()
setCurrentSelection(param): void
Parameters
Parameter | Type |
---|---|
param | ISelectionManagerSearchParam |
Returns
void
Defined in
packages/sheets/src/services/selection-manager.service.ts:169 (opens in a new tab)
setCurrentSelectionNotRefresh()
setCurrentSelectionNotRefresh(param): void
Parameters
Parameter | Type |
---|---|
param | ISelectionManagerSearchParam |
Returns
void
Defined in
packages/sheets/src/services/selection-manager.service.ts:178 (opens in a new tab)