@univerjs/sheets-formula-ui v0.4.2 • Docs

Class: RefSelectionsRenderService

This service extends the existing SelectionRenderService to provide the rendering of prompt selections when user is editing ref ranges in formulas.

Not that this service works with Uni-mode, which means it should be able to deal with multi render unit and handle selections on them, though each at a time.

Extends

• BaseSelectionRenderService

Implements

• IRenderModule

Constructors

new RefSelectionsRenderService()

new RefSelectionsRenderService(
   _context, 
   injector, 
   themeService, 
   shortcutService, 
   sheetSkeletonManagerService, 
   _refSelectionsService): RefSelectionsRenderService

Parameters

Returns

RefSelectionsRenderService

Overrides

BaseSelectionRenderService.constructor

Defined in

sheets-formula-ui/src/services/render-services/ref-selections.render-service.ts:42 (opens in a new tab)

Properties

Accessors

selectionMoving

get selectionMoving(): boolean

Returns

boolean

Inherited from

BaseSelectionRenderService.selectionMoving

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:165 (opens in a new tab)

Methods

_addEndingListeners()

protected _addEndingListeners(): void

Returns

void

Inherited from

BaseSelectionRenderService._addEndingListeners

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:888 (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

Returns

void

Inherited from

BaseSelectionRenderService._addSelectionControlBySelectionData

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:221 (opens in a new tab)

_changeRuntime()

protected _changeRuntime(
   skeleton, 
   scene, 
   viewport?): void

Parameters

Returns

void

Inherited from

BaseSelectionRenderService._changeRuntime

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:299 (opens in a new tab)

_checkClearPreviousControls()

protected _checkClearPreviousControls(evt): void

Parameters

Returns

void

Inherited from

BaseSelectionRenderService._checkClearPreviousControls

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:976 (opens in a new tab)

_clearSelectionControls()

protected _clearSelectionControls(): void

Returns

void

Inherited from

BaseSelectionRenderService._clearSelectionControls

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:332 (opens in a new tab)

_clearUpdatingListeners()

protected _clearUpdatingListeners(): void

Returns

void

Inherited from

BaseSelectionRenderService._clearUpdatingListeners

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:873 (opens in a new tab)

_getCellRangeByCursorPosition()

protected _getCellRangeByCursorPosition(
   offsetX, 
   offsetY, 
   scaleX, 
   scaleY, 
scrollXY): Nullable<ISelectionWithCoord>

Parameters

Returns

Nullable<ISelectionWithCoord>

Inherited from

BaseSelectionRenderService._getCellRangeByCursorPosition

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:904 (opens in a new tab)

_getFreeze()

protected _getFreeze(): Nullable<IFreeze>

Returns

Nullable<IFreeze>

Inherited from

BaseSelectionRenderService._getFreeze

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:341 (opens in a new tab)

_getViewportByCell()

protected _getViewportByCell(row?, column?): Nullable<Viewport>

Parameters

Returns

Nullable<Viewport>

Inherited from

BaseSelectionRenderService._getViewportByCell

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:346 (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

Returns

void

Inherited from

BaseSelectionRenderService._movingHandler

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:768 (opens in a new tab)

_onPointerDown()

protected _onPointerDown(
   evt, 
   _zIndex, 
   rangeType, 
   viewport, 
   scrollTimerType): void

Handle pointer down event, then trigger selectionMoveStart$.

Parameters

Returns

void

Inherited from

BaseSelectionRenderService._onPointerDown

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:433 (opens in a new tab)

_refreshSelectionControl()

protected _refreshSelectionControl(selectionsData): void

Reset all this.selectionControls by selectionsData.

Parameters

Returns

void

Overrides

BaseSelectionRenderService._refreshSelectionControl

Defined in

sheets-formula-ui/src/services/render-services/ref-selections.render-service.ts:236 (opens in a new tab)

_reset()

protected _reset(): void

Clear existed selections.

Returns

void

Inherited from

BaseSelectionRenderService._reset

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:411 (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

sheets-ui/src/services/selection/base-selection-render.service.ts:204 (opens in a new tab)

_setSelectionStyle()

protected _setSelectionStyle(style): void

Parameters

Returns

void

Inherited from

BaseSelectionRenderService._setSelectionStyle

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:197 (opens in a new tab)

_setupPointerMoveListener()

protected _setupPointerMoveListener(
   viewportMain, 
   activeSelectionControl, 
   rangeType, 
   scrollTimerType, 
   moveStartPosX, 
   moveStartPosY): void

Init pointer move listener in each pointer down, unbind in each pointer up. Both cell selections and row-column selections are supported by this method.

Parameters

Returns

void

Inherited from

BaseSelectionRenderService._setupPointerMoveListener

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:570 (opens in a new tab)

_updateSelectionControlByRange()

protected _updateSelectionControlByRange(
   control, 
   newSelectionRange, 
   highlight): void

Update the selection control by range.

Parameters

Returns

void

Inherited from

BaseSelectionRenderService._updateSelectionControlByRange

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:863 (opens in a new tab)

attachPrimaryWithCoord()

attachPrimaryWithCoord(primary): ISelectionCellWithMergeInfo

Parameters

Returns

ISelectionCellWithMergeInfo

Deprecated

Use the function attachPrimaryWithCoord instead`.

Inherited from

BaseSelectionRenderService.attachPrimaryWithCoord

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:745 (opens in a new tab)

attachSelectionWithCoord()

attachSelectionWithCoord(selectionWithStyle): ISelectionWithCoordAndStyle

Parameters

Returns

ISelectionWithCoordAndStyle

Deprecated

Use the function attachSelectionWithCoord instead`.

Inherited from

BaseSelectionRenderService.attachSelectionWithCoord

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:740 (opens in a new tab)

clearLastSelection()

clearLastSelection(): void

Returns

void

Defined in

sheets-formula-ui/src/services/render-services/ref-selections.render-service.ts:84 (opens in a new tab)

dispose()

dispose(): void

Returns

void

Implementation of

IRenderModule.dispose

Inherited from

BaseSelectionRenderService.dispose

Defined in

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

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Returns

IDisposable

Inherited from

BaseSelectionRenderService.disposeWithMe

Defined in

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

enableSelectionChanging()

enableSelectionChanging(): IDisposable

Call this method and user will be able to select on the canvas to update selections.

Returns

IDisposable

Defined in

sheets-formula-ui/src/services/render-services/ref-selections.render-service.ts:95 (opens in a new tab)

endSelection()

endSelection(): void

Returns

void

Inherited from

BaseSelectionRenderService.endSelection

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:399 (opens in a new tab)

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

BaseSelectionRenderService.ensureNotDisposed

Defined in

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

Nullable<IRange>

Inherited from

BaseSelectionRenderService.getActiveRange

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:375 (opens in a new tab)

getActiveSelectionControl()

getActiveSelectionControl<T>(): Nullable<T>

get active selection control

Type Parameters

Returns

Nullable<T>

T extends SelectionControl

Inherited from

BaseSelectionRenderService.getActiveSelectionControl

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:392 (opens in a new tab)

getLocation()

getLocation(): [string, string]

Returns

[string, string]

Defined in

sheets-formula-ui/src/services/render-services/ref-selections.render-service.ts:67 (opens in a new tab)

getSelectionCellByPosition()

getSelectionCellByPosition(x, y): Nullable<ISelectionCellWithMergeInfo>

Parameters

Returns

Nullable<ISelectionCellWithMergeInfo>

Inherited from

BaseSelectionRenderService.getSelectionCellByPosition

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:749 (opens in a new tab)

getSelectionControls()

getSelectionControls(): SelectionShape[]

Returns

SelectionShape[]

Inherited from

BaseSelectionRenderService.getSelectionControls

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:328 (opens in a new tab)

getSelectionDataWithStyle()

getSelectionDataWithStyle(): ISelectionWithCoordAndStyle[]

Generate selectionData from this._selectionControls.model .

Returns

ISelectionWithCoordAndStyle[]

{range, primary, style}[]

Inherited from

BaseSelectionRenderService.getSelectionDataWithStyle

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:317 (opens in a new tab)

getSkeleton()

getSkeleton(): SpreadsheetSkeleton

Returns

SpreadsheetSkeleton

Inherited from

BaseSelectionRenderService.getSkeleton

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:309 (opens in a new tab)

getViewPort()

getViewPort(): Viewport

Returns

Viewport

Deprecated

This should not be provided by the selection render service.

Inherited from

BaseSelectionRenderService.getViewPort

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:209 (opens in a new tab)

newSelectionControl()

newSelectionControl(
   scene, 
   _rangeType, 
   skeleton): SelectionShape

Parameters

Returns

SelectionShape

Inherited from

BaseSelectionRenderService.newSelectionControl

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:245 (opens in a new tab)

refreshSelectionMoveEnd()

refreshSelectionMoveEnd(): void

Returns

void

Inherited from

BaseSelectionRenderService.refreshSelectionMoveEnd

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:295 (opens in a new tab)

refreshSelectionMoveStart()

refreshSelectionMoveStart(): void

Returns

void

Inherited from

BaseSelectionRenderService.refreshSelectionMoveStart

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:291 (opens in a new tab)

resetAndEndSelection()

resetAndEndSelection(): void

Returns

void

Inherited from

BaseSelectionRenderService.resetAndEndSelection

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:417 (opens in a new tab)

setRemainLastEnabled()

setRemainLastEnabled(enabled): void

Parameters

Returns

void

Defined in

sheets-formula-ui/src/services/render-services/ref-selections.render-service.ts:71 (opens in a new tab)

setSingleSelectionEnabled()

setSingleSelectionEnabled(enabled): void

Parameters

Returns

void

Inherited from

BaseSelectionRenderService.setSingleSelectionEnabled

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:213 (opens in a new tab)

setSkipLastEnabled()

setSkipLastEnabled(enabled): void

This is set to true when you need to add a new selection.

Parameters

Returns

void

Memberof

RefSelectionsRenderService

Defined in

sheets-formula-ui/src/services/render-services/ref-selections.render-service.ts:80 (opens in a new tab)

updateControlForCurrentByRangeData()

updateControlForCurrentByRangeData(selections): void

Update the corresponding selectionControl based on selectionsData. selectionData[i] syncs selectionControls[i]

Parameters

Returns

void

Inherited from

BaseSelectionRenderService.updateControlForCurrentByRangeData

Defined in

sheets-ui/src/services/selection/base-selection-render.service.ts:263 (opens in a new tab)