@univerjs/sheets-ui v0.2.11 • Docs
Class: SheetSelectionRenderService
This services controls rendering of normal selections in a render unit. The normal selections would also be used by Auto Fill and Copy features.
Extends
Implements
Constructors
new SheetSelectionRenderService()
new SheetSelectionRenderService(
_context,
injector,
themeService,
shortcutService,
selectionManagerService,
sheetSkeletonManagerService,
_logService,
_commandService,
_contextService): SheetSelectionRenderService
Parameters
Parameter | Type |
---|---|
_context | IRenderContext <Workbook > |
injector | Injector |
themeService | ThemeService |
shortcutService | IShortcutService |
selectionManagerService | SheetsSelectionsService |
sheetSkeletonManagerService | SheetSkeletonManagerService |
_logService | ILogService |
_commandService | ICommandService |
_contextService | IContextService |
Returns
Overrides
BaseSelectionRenderService
.constructor
Defined in
packages/sheets-ui/src/services/selection/selection-render.service.ts:42 (opens in a new tab)
Properties
Accessors
selectionMoving
get selectionMoving(): boolean
Returns
boolean
Inherited from
BaseSelectionRenderService
.selectionMoving
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:154 (opens in a new tab)
Methods
_addEndingListeners()
protected _addEndingListeners(): void
Returns
void
Inherited from
BaseSelectionRenderService
._addEndingListeners
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:848 (opens in a new tab)
_addSelectionControlBySelectionData()
protected _addSelectionControlBySelectionData(selection): void
Add a selection in spreadsheet, create a new SelectionControl and then update this control by range derives from selection.
Parameters
Parameter | Type |
---|---|
selection | ISelectionWithCoordAndStyle |
Returns
void
Inherited from
BaseSelectionRenderService
._addSelectionControlBySelectionData
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:210 (opens in a new tab)
_changeRuntime()
protected _changeRuntime(
skeleton,
scene,
viewport?): void
Parameters
Parameter | Type |
---|---|
skeleton | SpreadsheetSkeleton |
scene | Scene |
viewport ? | Viewport |
Returns
void
Inherited from
BaseSelectionRenderService
._changeRuntime
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:284 (opens in a new tab)
_checkClearPreviousControls()
protected _checkClearPreviousControls(evt): void
Parameters
Parameter | Type |
---|---|
evt | IMouseEvent | IPointerEvent |
Returns
void
Inherited from
BaseSelectionRenderService
._checkClearPreviousControls
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:936 (opens in a new tab)
_clearSelectionControls()
protected _clearSelectionControls(): void
Returns
void
Inherited from
BaseSelectionRenderService
._clearSelectionControls
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:313 (opens in a new tab)
_clearUpdatingListeners()
protected _clearUpdatingListeners(): void
Returns
void
Inherited from
BaseSelectionRenderService
._clearUpdatingListeners
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:833 (opens in a new tab)
_getCellRangeByCursorPosition()
protected _getCellRangeByCursorPosition(
offsetX,
offsetY,
scaleX,
scaleY,
scrollXY): Nullable<ISelectionWithCoord>
Parameters
Parameter | Type |
---|---|
offsetX | number |
offsetY | number |
scaleX | number |
scaleY | number |
scrollXY | object |
scrollXY.x | number |
scrollXY.y | number |
Returns
Inherited from
BaseSelectionRenderService
._getCellRangeByCursorPosition
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:864 (opens in a new tab)
_getFreeze()
protected _getFreeze(): Nullable<IFreeze>
Returns
Inherited from
BaseSelectionRenderService
._getFreeze
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:322 (opens in a new tab)
_getViewportByCell()
protected _getViewportByCell(row?, column?): Nullable<Viewport>
Parameters
Parameter | Type |
---|---|
row ? | number |
column ? | number |
Returns
Inherited from
BaseSelectionRenderService
._getViewportByCell
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:327 (opens in a new tab)
_movingHandler()
protected _movingHandler(
offsetX,
offsetY,
activeSelectionControl,
rangeType): void
When mousedown and mouseup need to go to the coordination and undo stack, when mousemove does not need to go to the coordination and undo stack
Parameters
Parameter | Type |
---|---|
offsetX | number |
offsetY | number |
activeSelectionControl | Nullable <SelectionShape > |
rangeType | RANGE_TYPE |
Returns
void
Inherited from
BaseSelectionRenderService
._movingHandler
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:730 (opens in a new tab)
_onPointerDown()
protected _onPointerDown(
evt,
_zIndex,
rangeType,
viewport,
scrollTimerType): void
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
evt | IMouseEvent | IPointerEvent | undefined | component point event |
_zIndex | number | 0 | Stacking order of the selection object |
rangeType | RANGE_TYPE | RANGE_TYPE.NORMAL | Determines whether the selection is made normally according to the range or by rows and columns |
viewport | Nullable <Viewport > | undefined | - |
scrollTimerType | ScrollTimerType | ScrollTimerType.ALL | - |
Returns
void
Inherited from
BaseSelectionRenderService
._onPointerDown
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:413 (opens in a new tab)
_refreshSelectionControl()
protected _refreshSelectionControl(selectionsData): void
Reset all this.selectionControls by selectionsData.
Parameters
Parameter | Type |
---|---|
selectionsData | readonly ISelectionWithStyle [] |
Returns
void
Inherited from
BaseSelectionRenderService
._refreshSelectionControl
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:1012 (opens in a new tab)
_reset()
protected _reset(): void
Clear existed selections.
Returns
void
Inherited from
BaseSelectionRenderService
._reset
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:392 (opens in a new tab)
_resetSelectionStyle()
protected _resetSelectionStyle(): void
Reset this._selectionStyle to default normal selection style
Returns
void
Inherited from
BaseSelectionRenderService
._resetSelectionStyle
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:193 (opens in a new tab)
_setSelectionStyle()
protected _setSelectionStyle(style): void
Parameters
Parameter | Type |
---|---|
style | ISelectionStyle |
Returns
void
Inherited from
BaseSelectionRenderService
._setSelectionStyle
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:186 (opens in a new tab)
_setupPointerMoveListener()
protected _setupPointerMoveListener(
viewportMain,
activeSelectionControl,
rangeType,
scrollTimerType,
moveStartPosX,
moveStartPosY): void
Init pointer move listener, bind in each pointer down, unbind in each pointer up
Parameters
Parameter | Type | Default value |
---|---|---|
viewportMain | Nullable <Viewport > | undefined |
activeSelectionControl | SelectionShape | undefined |
rangeType | RANGE_TYPE | undefined |
scrollTimerType | ScrollTimerType | ScrollTimerType.ALL |
moveStartPosX | number | undefined |
moveStartPosY | number | undefined |
Returns
void
Inherited from
BaseSelectionRenderService
._setupPointerMoveListener
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:549 (opens in a new tab)
_updateSelectionControlByRange()
protected _updateSelectionControlByRange(
control,
newSelectionRange,
highlight): void
Update the selection control by range.
Parameters
Parameter | Type |
---|---|
control | SelectionShape |
newSelectionRange | IRangeWithCoord |
highlight | Nullable <ISelectionCellWithMergeInfo > |
Returns
void
Inherited from
BaseSelectionRenderService
._updateSelectionControlByRange
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:823 (opens in a new tab)
attachPrimaryWithCoord()
attachPrimaryWithCoord(primary): ISelectionCellWithMergeInfo
Parameters
Parameter | Type |
---|---|
primary | ISelectionCell |
Returns
Deprecated
Use the function attachPrimaryWithCoord
instead`.
Inherited from
BaseSelectionRenderService
.attachPrimaryWithCoord
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:707 (opens in a new tab)
attachSelectionWithCoord()
attachSelectionWithCoord(selectionWithStyle): ISelectionWithCoordAndStyle
Parameters
Parameter | Type |
---|---|
selectionWithStyle | ISelectionWithStyle |
Returns
Deprecated
Use the function attachSelectionWithCoord
instead`.
Inherited from
BaseSelectionRenderService
.attachSelectionWithCoord
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:702 (opens in a new tab)
dispose()
dispose(): void
Returns
void
Implementation of
Inherited from
BaseSelectionRenderService
.dispose
Defined in
packages/core/src/shared/lifecycle.ts:106 (opens in a new tab)
disposeWithMe()
protected disposeWithMe(disposable): IDisposable
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
Inherited from
BaseSelectionRenderService
.disposeWithMe
Defined in
packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)
endSelection()
endSelection(): void
Returns
void
Inherited from
BaseSelectionRenderService
.endSelection
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:380 (opens in a new tab)
ensureNotDisposed()
protected ensureNotDisposed(): void
Returns
void
Inherited from
BaseSelectionRenderService
.ensureNotDisposed
Defined in
packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)
getActiveRange()
getActiveRange(): Nullable<IRange>
Returns the selected range in the active sheet, or null if there is no active range. If multiple ranges are selected this method returns only the last selected range.
Returns
Inherited from
BaseSelectionRenderService
.getActiveRange
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:356 (opens in a new tab)
getActiveSelectionControl()
getActiveSelectionControl<T>(): Nullable<T>
get active selection control
Type Parameters
Type Parameter | Default type |
---|---|
T extends SelectionShape | SelectionShape |
Returns
Nullable
<T
>
T extends SelectionControl
Inherited from
BaseSelectionRenderService
.getActiveSelectionControl
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:373 (opens in a new tab)
getSelectionCellByPosition()
getSelectionCellByPosition(x, y): Nullable<ISelectionCellWithMergeInfo>
Parameters
Parameter | Type |
---|---|
x | number |
y | number |
Returns
Nullable
<ISelectionCellWithMergeInfo
>
Inherited from
BaseSelectionRenderService
.getSelectionCellByPosition
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:711 (opens in a new tab)
getSelectionControls()
getSelectionControls(): SelectionShape[]
Returns
Inherited from
BaseSelectionRenderService
.getSelectionControls
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:309 (opens in a new tab)
getSelectionDataWithStyle()
getSelectionDataWithStyle(): ISelectionWithCoordAndStyle[]
Generate selectionData from this._selectionControls.model .
Returns
{range, primary, style}[]
Inherited from
BaseSelectionRenderService
.getSelectionDataWithStyle
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:298 (opens in a new tab)
getSkeleton()
getSkeleton(): SpreadsheetSkeleton
Returns
Inherited from
BaseSelectionRenderService
.getSkeleton
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:290 (opens in a new tab)
getViewPort()
getViewPort(): Viewport
Returns
Deprecated
This should not be provided by the selection render service.
Inherited from
BaseSelectionRenderService
.getViewPort
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:198 (opens in a new tab)
newSelectionControl()
newSelectionControl(
scene,
_rangeType,
skeleton): SelectionShape
Parameters
Parameter | Type |
---|---|
scene | Scene |
_rangeType | RANGE_TYPE |
skeleton | SpreadsheetSkeleton |
Returns
Inherited from
BaseSelectionRenderService
.newSelectionControl
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:234 (opens in a new tab)
refreshSelectionMoveStart()
refreshSelectionMoveStart(): void
Returns
void
Inherited from
BaseSelectionRenderService
.refreshSelectionMoveStart
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:280 (opens in a new tab)
resetAndEndSelection()
resetAndEndSelection(): void
Returns
void
Inherited from
BaseSelectionRenderService
.resetAndEndSelection
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:398 (opens in a new tab)
setSingleSelectionEnabled()
setSingleSelectionEnabled(enabled): void
Parameters
Parameter | Type | Default value |
---|---|---|
enabled | boolean | false |
Returns
void
Inherited from
BaseSelectionRenderService
.setSingleSelectionEnabled
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:202 (opens in a new tab)
updateControlForCurrentByRangeData()
updateControlForCurrentByRangeData(selections): void
Update the corresponding selectionControl based on selectionsData. selectionData[i] syncs selectionControls[i]
Parameters
Parameter | Type |
---|---|
selections | ISelectionWithCoordAndStyle [] |
Returns
void
Inherited from
BaseSelectionRenderService
.updateControlForCurrentByRangeData
Defined in
packages/sheets-ui/src/services/selection/base-selection-render.service.ts:252 (opens in a new tab)