@univerjs/sheets-ui v0.1.17 • Docs

Class: SelectionShape

The main selection canvas component

Extends

• Disposable

Constructors

new SelectionShape()

new SelectionShape(
   _scene, 
   _zIndex, 
   _isHeaderHighlight, 
   _themeService): SelectionShape

Parameters

Returns

SelectionShape

Overrides

Disposable.constructor

Defined in

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

Properties

Accessors

backgroundControlBottom

get backgroundControlBottom(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

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

backgroundControlMiddleLeft

get backgroundControlMiddleLeft(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

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

backgroundControlMiddleRight

get backgroundControlMiddleRight(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

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

backgroundControlTop

get backgroundControlTop(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

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

bottomCenterWidget

get bottomCenterWidget(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

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

bottomControl

get bottomControl(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

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

bottomLeftWidget

get bottomLeftWidget(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

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

bottomRightWidget

get bottomRightWidget(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

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

dashRect

get dashRect(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

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

fillControl

get fillControl(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

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

isHelperSelection

get isHelperSelection(): boolean

Returns

boolean

Defined in

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

leftControl

get leftControl(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

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

middleLeftWidget

get middleLeftWidget(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

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

middleRightWidget

get middleRightWidget(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

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

model

get model(): SelectionRenderModel

Returns

SelectionRenderModel

Defined in

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

rightControl

get rightControl(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

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

selectionShape

get selectionShape(): Group

Returns

Group

Defined in

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

selectionStyle

get selectionStyle(): Nullable<ISelectionStyle>

Returns

Nullable<ISelectionStyle>

Defined in

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

topCenterWidget

get topCenterWidget(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

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

topControl

get topControl(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

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

topLeftWidget

get topLeftWidget(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

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

topRightWidget

get topRightWidget(): Rect<IRectProps>

Returns

Rect<IRectProps>

Defined in

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

zIndex

get zIndex(): number

Returns

number

Defined in

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

Methods

clearHighlight()

clearHighlight(): void

Returns

void

Defined in

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

disableHeaderHighlight()

disableHeaderHighlight(): void

Returns

void

Defined in

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

disableHelperSelection()

disableHelperSelection(): void

Returns

void

Defined in

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

dispose()

dispose(): void

Returns

void

Overrides

Disposable.dispose

Defined in

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

disposeWithMe()

protected disposeWithMe(disposable): IDisposable

Parameters

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

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

enableHeaderHighlight()

enableHeaderHighlight(): void

Returns

void

Defined in

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

enableHelperSelection()

enableHelperSelection(): void

Returns

void

Defined in

packages/sheets-ui/src/services/selection/selection-shape.ts:368 (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-shape.ts:320 (opens in a new tab)

getRange()

getRange(): IRangeWithCoord

Returns

IRangeWithCoord

Defined in

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

getScene()

getScene(): Scene

Returns

Scene

Defined in

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

getValue()

getValue(): ISelectionWithCoordAndStyle

Returns

ISelectionWithCoordAndStyle

Defined in

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

refreshSelectionFilled()

refreshSelectionFilled(val): void

Parameters

Returns

void

Defined in

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

setEvent()

setEvent(state): void

Parameters

Returns

void

Defined in

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

update()

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

Parameters

Returns

void

Defined in

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

updateStyle()

updateStyle(style): void

Parameters

Returns

void

Defined in

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

updateStyleId()

updateStyleId(id): void

Parameters

Returns

void

Defined in

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