@univerjs/sheets-ui v0.4.2 • Docs

Class: SelectionShape

The main selection canvas component, includes leftControl,rightControl,topControl,bottomControl,backgroundControlTop,backgroundControlMiddleLeft,backgroundControlMiddleRight,backgroundControlBottom,fillControl

Extends

Disposable

Constructors

new SelectionShape()

new SelectionShape(
   _scene, 
   _zIndex, 
   _themeService, 
   _highlightHeader, 
   options?): SelectionShape

Parameters

Parameter	Type	Default value
`_scene`	`Scene`	`undefined`
`_zIndex`	`number`	`undefined`
`_themeService`	`ThemeService`	`undefined`
`_highlightHeader`	`boolean`	`true`
`options`?	`object`	`undefined`
`options.columnHeaderHeight`?	`number`	`undefined`
`options.rowHeaderWidth`?	`number`	`undefined`

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
`_columnHeaderHeight`	`protected`	`number`	`0`	-	-	packages/sheets-ui/src/services/selection/selection-control.ts:122 (opens in a new tab)
`_disposed`	`protected`	`boolean`	`false`	-	`Disposable`.`_disposed`	packages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
`_highlightHeader`	`protected`	`boolean`	`true`	-	-	packages/sheets-ui/src/services/selection/selection-control.ts:149 (opens in a new tab)
`_rowHeaderWidth`	`protected`	`number`	`0`	-	-	packages/sheets-ui/src/services/selection/selection-control.ts:121 (opens in a new tab)
`_scene`	`protected`	`Scene`	`undefined`	-	-	packages/sheets-ui/src/services/selection/selection-control.ts:146 (opens in a new tab)
`_selectionModel`	`protected`	`SelectionRenderModel`	`undefined`	-	-	packages/sheets-ui/src/services/selection/selection-control.ts:114 (opens in a new tab)
`_themeService`	`readonly`	`ThemeService`	`undefined`	-	-	packages/sheets-ui/src/services/selection/selection-control.ts:148 (opens in a new tab)
`_widgetRects`	`protected`	`Rect`<`IRectProps`>[]	`[]`	-	-	packages/sheets-ui/src/services/selection/selection-control.ts:124 (opens in a new tab)
`_zIndex`	`protected`	`number`	`undefined`	-	-	packages/sheets-ui/src/services/selection/selection-control.ts:147 (opens in a new tab)
`dispose$`	`readonly`	`Observable`<`SelectionShape`>	`undefined`	-	-	packages/sheets-ui/src/services/selection/selection-control.ts:127 (opens in a new tab)
`selectionFilled$`	`readonly`	`Observable`<`Nullable`<`IRangeWithCoord`>>	`undefined`	-	-	packages/sheets-ui/src/services/selection/selection-control.ts:141 (opens in a new tab)
`selectionFilling$`	`readonly`	`Subject`<`Nullable`<`IRangeWithCoord`>>	`undefined`	-	-	packages/sheets-ui/src/services/selection/selection-control.ts:137 (opens in a new tab)
`selectionMoved$`	`readonly`	`Subject`<`IRangeWithCoord`>	`undefined`	-	-	packages/sheets-ui/src/services/selection/selection-control.ts:134 (opens in a new tab)
`selectionMoving$`	`readonly`	`Subject`<`IRangeWithCoord`>	`undefined`	eventSource: selectionShapeExtension selectionMoving$.next, Observer: prompt.controller	-	packages/sheets-ui/src/services/selection/selection-control.ts:133 (opens in a new tab)
`selectionScaled$`	`readonly`	`Subject`<`Nullable`<`IRangeWithCoord`>>	`undefined`	-	-	packages/sheets-ui/src/services/selection/selection-control.ts:136 (opens in a new tab)
`selectionScaling$`	`readonly`	`Subject`<`IRangeWithCoord`>	`undefined`	-	-	packages/sheets-ui/src/services/selection/selection-control.ts:135 (opens in a new tab)

Accessors

backgroundControlBottom

get backgroundControlBottom(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:189 (opens in a new tab)

backgroundControlMiddleLeft

get backgroundControlMiddleLeft(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:193 (opens in a new tab)

backgroundControlMiddleRight

get backgroundControlMiddleRight(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:197 (opens in a new tab)

backgroundControlTop

get backgroundControlTop(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:185 (opens in a new tab)

bottomCenterWidget

get bottomCenterWidget(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:245 (opens in a new tab)

bottomControl

get bottomControl(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:177 (opens in a new tab)

bottomLeftWidget

get bottomLeftWidget(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:241 (opens in a new tab)

bottomRightWidget

get bottomRightWidget(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:249 (opens in a new tab)

columnHeaderGroup

get columnHeaderGroup(): Group

Returns

Group

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:205 (opens in a new tab)

columnHeaderHeight

get columnHeaderHeight(): number

set columnHeaderHeight(height): void

Parameters

Parameter	Type
`height`	`number`

Returns

number

Defined in

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

currentStyle

get currentStyle(): Nullable<ISelectionStyle>

set currentStyle(style): void

Parameters

Parameter	Type
`style`	`Nullable`<`ISelectionStyle`>

Returns

Nullable<ISelectionStyle>

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:277 (opens in a new tab)

dashedRect

get dashedRect(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:273 (opens in a new tab)

defaultStyle

get defaultStyle(): ISelectionStyle

set defaultStyle(style): void

Parameters

Parameter	Type
`style`	`ISelectionStyle`

Returns

ISelectionStyle

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:265 (opens in a new tab)

fillControl

get fillControl(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:181 (opens in a new tab)

isHelperSelection

get isHelperSelection(): boolean

Returns

boolean

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:287 (opens in a new tab)

leftControl

get leftControl(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:165 (opens in a new tab)

middleLeftWidget

get middleLeftWidget(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:233 (opens in a new tab)

middleRightWidget

get middleRightWidget(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:237 (opens in a new tab)

model

get model(): SelectionRenderModel

Returns

SelectionRenderModel

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:217 (opens in a new tab)

rightControl

get rightControl(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:169 (opens in a new tab)

rowHeaderGroup

get rowHeaderGroup(): Group

Returns

Group

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:209 (opens in a new tab)

rowHeaderWidth

get rowHeaderWidth(): number

set rowHeaderWidth(width): void

Parameters

Parameter	Type
`width`	`number`

Returns

number

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:291 (opens in a new tab)

selectionModel

get selectionModel(): SelectionRenderModel

set selectionModel(model): void

Parameters

Parameter	Type
`model`	`SelectionRenderModel`

Returns

SelectionRenderModel

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:257 (opens in a new tab)

selectionShape

get selectionShape(): Group

Returns

Group

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:201 (opens in a new tab)

selectionShapeGroup

get selectionShapeGroup(): Group

Returns

Group

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:213 (opens in a new tab)

themeService

get themeService(): ThemeService

Returns

ThemeService

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:253 (opens in a new tab)

topCenterWidget

get topCenterWidget(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:225 (opens in a new tab)

topControl

get topControl(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:173 (opens in a new tab)

topLeftWidget

get topLeftWidget(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:221 (opens in a new tab)

topRightWidget

get topRightWidget(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:229 (opens in a new tab)

zIndex

get zIndex(): number

Returns

number

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:161 (opens in a new tab)

Methods

_hasWidgets()

protected _hasWidgets(widgets): boolean

Parameters

Parameter	Type
`widgets`	`ISelectionWidgetConfig`

Returns

boolean

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:1035 (opens in a new tab)

_refreshControlPosition()

protected _refreshControlPosition(): void

update selection control position by curr selection model

Returns

void

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:459 (opens in a new tab)

_setSizeAndStyleForSelectionControl()

protected _setSizeAndStyleForSelectionControl(selectionStyle): void

Update Control Style And Position of SelectionControl

Parameters

Parameter	Type
`selectionStyle`	`ISelectionStyle`

Returns

void

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:323 (opens in a new tab)

clearHighlight()

clearHighlight(): void

Returns

void

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:509 (opens in a new tab)

disableHelperSelection()

disableHelperSelection(): void

Returns

void

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:609 (opens in a new tab)

dispose()

dispose(): void

Returns

void

Overrides

Disposable.dispose

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:519 (opens in a new tab)

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

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

enableHelperSelection()

enableHelperSelection(): void

Returns

void

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:605 (opens in a new tab)

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

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

getCurrentCellInfo()

getCurrentCellInfo(): Nullable<IRangeWithCoord>

Get the cell information of the current selection, considering the case of merging cells

Returns

Nullable<IRangeWithCoord>

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:557 (opens in a new tab)

getRange()

getRange(): IRangeWithCoord

Returns

IRangeWithCoord

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:601 (opens in a new tab)

getScene()

getScene(): Scene

Returns

Scene

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:514 (opens in a new tab)

getValue()

getValue(): ISelectionWithCoordAndStyle

Returns

ISelectionWithCoordAndStyle

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:594 (opens in a new tab)

refreshSelectionFilled()

refreshSelectionFilled(val): void

Parameters

Parameter	Type
`val`	`IRangeWithCoord`

Returns

void

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:314 (opens in a new tab)

setEvent()

setEvent(state): void

Parameters

Parameter	Type
`state`	`boolean`

Returns

void

Defined in

packages/sheets-ui/src/services/selection/selection-control.ts:307 (opens in a new tab)

update()

update(
   newSelectionRange, 
   rowHeaderWidth, 
   columnHeaderHeight, 
   style?, 
   primaryCell?): void

Update selection model with new range & primary cell(aka: highlight/current), also update row/col selection size & style.

Parameters

Parameter	Type	Default value	Description
`newSelectionRange`	`IRangeWithCoord`	`undefined`	-
`rowHeaderWidth`	`number`	`0`	-
`columnHeaderHeight`	`number`	`0`	-
`style`?	`Nullable`<`ISelectionStyle`>	`undefined`	-
`primaryCell`?	`Nullable`<`ISelectionCellWithMergeInfo`>	`undefined`	primary cell