@univerjs/sheets-ui v0.1.17 • Docs

Class: SelectionRenderService

Implements

ISelectionRenderService

Constructors

new SelectionRenderService()

new SelectionRenderService(
   _themeService, 
   _shortcutService, 
   _renderManagerService, 
   _instanceService, 
   _injector): SelectionRenderService

Parameters

Parameter	Type
`_themeService`	`ThemeService`
`_shortcutService`	`IShortcutService`
`_renderManagerService`	`IRenderManagerService`
`_instanceService`	`IUniverInstanceService`
`_injector`	`Injector`

Returns

SelectionRenderService

Defined in

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

Properties

Property	Modifier	Type	Default value	Description	Defined in
`controlFillConfig$`	`readonly`	`Observable`<`null` \| `IControlFillConfig`>	`undefined`	-	packages/sheets-ui/src/services/selection/selection-render.service.ts:136 (opens in a new tab)
`hasSelection`	`public`	`boolean`	`false`	-	packages/sheets-ui/src/services/selection/selection-render.service.ts:127 (opens in a new tab)
`interceptor`	`public`	`InterceptorManager`<{ `RANGE_FILL_PERMISSION_CHECK`: `IInterceptor`<`boolean`, { `scene`: `Scene`; `skeleton`: `SpreadsheetSkeleton`; `x`: `number`; `y`: `number`; }>; `RANGE_MOVE_PERMISSION_CHECK`: `IInterceptor`<`boolean`, `null`>; }>	`undefined`	-	packages/sheets-ui/src/services/selection/selection-render.service.ts:214 (opens in a new tab)
`selectionMoveEnd$`	`readonly`	`Observable`<`ISelectionWithCoordAndStyle`[]>	`undefined`	-	packages/sheets-ui/src/services/selection/selection-render.service.ts:189 (opens in a new tab)
`selectionMoveStart$`	`readonly`	`Observable`<`ISelectionWithCoordAndStyle`[]>	`undefined`	Triggered during the start draw the selection area.	packages/sheets-ui/src/services/selection/selection-render.service.ts:203 (opens in a new tab)
`selectionMoving$`	`readonly`	`Observable`<`ISelectionWithCoordAndStyle`[]>	`undefined`	Triggered during the drawing of the selection area.	packages/sheets-ui/src/services/selection/selection-render.service.ts:196 (opens in a new tab)
`usable$`	`readonly`	`Observable`<`boolean`>	`undefined`	-	packages/sheets-ui/src/services/selection/selection-render.service.ts:213 (opens in a new tab)

Methods

addControlToCurrentByRangeData()

addControlToCurrentByRangeData(data): void

add a selection

Parameters

Parameter	Type
`data`	`ISelectionWithCoordAndStyle`

Returns

void

Implementation of

ISelectionRenderService.addControlToCurrentByRangeData

Defined in

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

attachPrimaryWithCoord()

attachPrimaryWithCoord(primary): Nullable<ISelectionCellWithCoord>

Parameters

Parameter	Type
`primary`	`Nullable`<`ISelectionCell`>

attachRangeWithCoord()

attachRangeWithCoord(range): Nullable<IRangeWithCoord>

Parameters

Parameter	Type
`range`	`IRange`

Returns

Nullable<IRangeWithCoord>

Implementation of

ISelectionRenderService.attachRangeWithCoord

Defined in

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

attachSelectionWithCoord()

attachSelectionWithCoord(selectionWithStyle): ISelectionWithCoordAndStyle

Parameters

Parameter	Type
`selectionWithStyle`	`ISelectionWithStyle`

Returns

ISelectionWithCoordAndStyle

Implementation of

ISelectionRenderService.attachSelectionWithCoord

Defined in

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

changeRuntime()

changeRuntime(
   skeleton, 
   scene, 
   viewport?): void

Parameters

Parameter	Type
`skeleton`	`Nullable`<`SpreadsheetSkeleton`>
`scene`	`Nullable`<`Scene`>
`viewport`?	`Viewport`

Returns

void

Implementation of

ISelectionRenderService.changeRuntime

Defined in

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

disableDetectMergedCell()

disableDetectMergedCell(): void

Returns

void

Implementation of

ISelectionRenderService.disableDetectMergedCell

Defined in

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

disableHeaderHighlight()

disableHeaderHighlight(): void

Returns

void

Implementation of

ISelectionRenderService.disableHeaderHighlight

Defined in

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

disableRemainLast()

disableRemainLast(): void

Returns

void

Implementation of

ISelectionRenderService.disableRemainLast

Defined in

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

disableSelection()

disableSelection(): void

Returns

void

Implementation of

ISelectionRenderService.disableSelection

Defined in

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

disableShowPrevious()

disableShowPrevious(): void

Returns

void

Implementation of

ISelectionRenderService.disableShowPrevious

Defined in

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

disableSingleSelection()

disableSingleSelection(): void

Returns

void

Implementation of

ISelectionRenderService.disableSingleSelection

Defined in

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

disableSkipRemainLast()

disableSkipRemainLast(): void

Returns

void

Implementation of

ISelectionRenderService.disableSkipRemainLast

Defined in

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

enableDetectMergedCell()

enableDetectMergedCell(): void

Returns

void

Implementation of

ISelectionRenderService.enableDetectMergedCell

Defined in

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

enableHeaderHighlight()

enableHeaderHighlight(): void

Returns

void

Implementation of

ISelectionRenderService.enableHeaderHighlight

Defined in

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

enableRemainLast()

enableRemainLast(): void

Returns

void

Implementation of

ISelectionRenderService.enableRemainLast

Defined in

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

enableSelection()

enableSelection(): void

Returns

void

Implementation of

ISelectionRenderService.enableSelection

Defined in

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

enableShowPrevious()

enableShowPrevious(): void

Returns

void

Implementation of

ISelectionRenderService.enableShowPrevious

Defined in

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

enableSingleSelection()

enableSingleSelection(): void

Returns

void

Implementation of

ISelectionRenderService.enableSingleSelection

Defined in

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

enableSkipRemainLast()

enableSkipRemainLast(): void

Returns

void

Implementation of

ISelectionRenderService.enableSkipRemainLast

Defined in

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

endSelection()

endSelection(): void

Returns

void

Defined in

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

eventTrigger()

eventTrigger(
   evt, 
   zIndex, 
   rangeType, 
   viewport?, 
   scrollTimerType?): undefined | false

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`?	`Viewport`	`undefined`	-
`scrollTimerType`?	`ScrollTimerType`	`ScrollTimerType.ALL`	-

Returns

undefined | false

Implementation of

ISelectionRenderService.eventTrigger

Defined in

packages/sheets-ui/src/services/selection/selection-render.service.ts:534 (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. TODO: 默认最后一个选区为当前激活选区，或者当前激活单元格所在选区为激活选区

Returns

Nullable<IRange>

Implementation of

ISelectionRenderService.getActiveRange

Defined in

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

getActiveSelection()

getActiveSelection(): Nullable<SelectionShape>

get active selection control

Returns

Nullable<SelectionShape>

Implementation of

ISelectionRenderService.getActiveSelection

Defined in

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

getActiveSelections()

getActiveSelections(): Nullable<ISelection[]>

Returns the list of active ranges in the active sheet or null if there are no active ranges. If there is a single range selected, this behaves as a getActiveRange() call.

Returns

Nullable<ISelection[]>

Implementation of

ISelectionRenderService.getActiveSelections

Defined in

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

getCurrentControls()

getCurrentControls(): SelectionShape[]

Returns

SelectionShape[]

Implementation of

ISelectionRenderService.getCurrentControls

Defined in

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

getSelectionCellByPosition()

getSelectionCellByPosition(x, y): Nullable<ISelectionCellWithCoord>

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

Nullable<ISelectionCellWithCoord>

Implementation of

ISelectionRenderService.getSelectionCellByPosition

Defined in

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

getSelectionDataWithStyle()

getSelectionDataWithStyle(): ISelectionWithCoordAndStyle[]

Returns

ISelectionWithCoordAndStyle[]

Implementation of

ISelectionRenderService.getSelectionDataWithStyle

Defined in

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

getViewPort()

getViewPort(): Viewport

Returns

Viewport

Implementation of

ISelectionRenderService.getViewPort

Deprecated

This should not be provided by the selection render service.

Defined in

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

refreshSelectionMoveStart()

refreshSelectionMoveStart(): void

Returns

void

Implementation of

ISelectionRenderService.refreshSelectionMoveStart

Defined in

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

reset()

reset(): void

Returns

void

Implementation of

ISelectionRenderService.reset

Defined in

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

resetAndEndSelection()

resetAndEndSelection(): void

Returns

void

Defined in

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

resetStyle()

resetStyle(): void

Returns

void

Implementation of

ISelectionRenderService.resetStyle

Defined in

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

setStyle()

setStyle(style): void

Parameters

Parameter	Type
`style`	`ISelectionStyle`

Returns

void

Implementation of

ISelectionRenderService.setStyle

Defined in

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

updateControlForCurrentByRangeData()

updateControlForCurrentByRangeData(selections): void

Parameters

Parameter	Type
`selections`	`ISelectionWithCoordAndStyle`[]

Returns

void

Implementation of

ISelectionRenderService.updateControlForCurrentByRangeData

Defined in

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

Markselectionservice Selectionshape