@univerjs/sheets-ui v0.1.17 • Docs

Interface: ISelectionRenderService

Properties

Property	Modifier	Type	Defined in
`controlFillConfig$`	`readonly`	`Observable`<`null` \| `IControlFillConfig`>	packages/sheets-ui/src/services/selection/selection-render.service.ts:52 (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`>; }>	packages/sheets-ui/src/services/selection/selection-render.service.ts:57 (opens in a new tab)
`selectionMoveEnd$`	`readonly`	`Observable`<`ISelectionWithCoordAndStyle`[]>	packages/sheets-ui/src/services/selection/selection-render.service.ts:51 (opens in a new tab)
`selectionMoveStart$`	`readonly`	`Observable`<`ISelectionWithCoordAndStyle`[]>	packages/sheets-ui/src/services/selection/selection-render.service.ts:54 (opens in a new tab)
`selectionMoving$`	`readonly`	`Observable`<`ISelectionWithCoordAndStyle`[]>	packages/sheets-ui/src/services/selection/selection-render.service.ts:53 (opens in a new tab)
`usable$`	`readonly`	`Observable`<`boolean`>	packages/sheets-ui/src/services/selection/selection-render.service.ts:55 (opens in a new tab)

Methods

addControlToCurrentByRangeData()

addControlToCurrentByRangeData(data): void

Parameters

Parameter	Type
`data`	`ISelectionWithCoordAndStyle`

Returns

void

Defined in

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

attachPrimaryWithCoord()

attachPrimaryWithCoord(primary): Nullable<ISelectionCellWithCoord>

Parameters

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

Returns

Nullable<ISelectionCellWithCoord>

Defined in

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

attachRangeWithCoord()

attachRangeWithCoord(range): Nullable<IRangeWithCoord>

Parameters

Parameter	Type
`range`	`IRange`

Returns

Nullable<IRangeWithCoord>

Defined in

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

attachSelectionWithCoord()

attachSelectionWithCoord(selectionWithStyle): ISelectionWithCoordAndStyle

Parameters

Parameter	Type
`selectionWithStyle`	`ISelectionWithStyle`

Returns

ISelectionWithCoordAndStyle

Defined in

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

changeRuntime()

changeRuntime(
   skeleton, 
   scene, 
   viewport?): void

Parameters

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

Returns

void

Defined in

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

disableDetectMergedCell()

disableDetectMergedCell(): void

Returns

void

Defined in

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

disableHeaderHighlight()

disableHeaderHighlight(): void

Returns

void

Defined in

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

disableRemainLast()

disableRemainLast(): void

Returns

void

Defined in

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

disableSelection()

disableSelection(): void

Returns

void

Defined in

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

disableShowPrevious()

disableShowPrevious(): void

Returns

void

Defined in

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

disableSingleSelection()

disableSingleSelection(): void

Returns

void

Defined in

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

disableSkipRemainLast()

disableSkipRemainLast(): void

Returns

void

Defined in

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

enableDetectMergedCell()

enableDetectMergedCell(): void

Returns

void

Defined in

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

enableHeaderHighlight()

enableHeaderHighlight(): void

Returns

void

Defined in

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

enableRemainLast()

enableRemainLast(): void

Returns

void

Defined in

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

enableSelection()

enableSelection(): void

Returns

void

Defined in

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

enableShowPrevious()

enableShowPrevious(): void

Returns

void

Defined in

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

enableSingleSelection()

enableSingleSelection(): void

Returns

void

Defined in

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

enableSkipRemainLast()

enableSkipRemainLast(): void

Returns

void

Defined in

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

eventTrigger()

eventTrigger(
   evt, 
   zIndex, 
   rangeType, 
   viewport?, 
   scrollTimerType?): void

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`
`zIndex`	`number`
`rangeType`	`RANGE_TYPE`
`viewport`?	`Viewport`
`scrollTimerType`?	`ScrollTimerType`

Returns

void

Defined in

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

getActiveRange()

getActiveRange(): Nullable<IRange>

Returns

Nullable<IRange>

Defined in

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

getActiveSelection()

getActiveSelection(): Nullable<SelectionShape>

Returns

Nullable<SelectionShape>

Defined in

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

getActiveSelections()

getActiveSelections(): Nullable<ISelection[]>

Returns

Nullable<ISelection[]>

Defined in

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

getCurrentControls()

getCurrentControls(): SelectionShape[]

Returns

SelectionShape[]

Defined in

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

getSelectionCellByPosition()

getSelectionCellByPosition(x, y): Nullable<ISelectionCellWithCoord>

Parameters

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

Returns

Nullable<ISelectionCellWithCoord>

Defined in

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

getSelectionDataWithStyle()

getSelectionDataWithStyle(): ISelectionWithCoordAndStyle[]

Returns

ISelectionWithCoordAndStyle[]

Defined in

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

getViewPort()

getViewPort(): Viewport

Returns

Viewport

Deprecated

This should not be provided by the selection render service.

Defined in

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

refreshSelectionMoveStart()

refreshSelectionMoveStart(): void

Returns

void

Defined in

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

reset()

reset(): void

Returns

void

Defined in

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

resetStyle()

resetStyle(): void

Returns

void

Defined in

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

setStyle()

setStyle(style): void

Parameters

Parameter	Type
`style`	`ISelectionStyle`

Returns

void

Defined in

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

updateControlForCurrentByRangeData()

updateControlForCurrentByRangeData(selections): void

Parameters

Parameter	Type
`selections`	`ISelectionWithCoordAndStyle`[]

Returns

void

Defined in

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

Iscrolltocellcommandparams Isetscrollrelativecommandparams