@univerjs/engine-render v0.4.2 • Docs

Class: `abstract` SheetComponent

Extends

RenderComponent<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]>

Extended by

Constructors

new SheetComponent()

new SheetComponent(oKey, _skeleton?): SheetComponent

Parameters

Parameter	Type
`oKey`	`string`
`_skeleton`?	`SpreadsheetSkeleton`

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_dirty`	`protected`	`boolean`	`true`	`RenderComponent`.`_dirty`	submodules/univer/packages/engine-render/src/base-object.ts:88 (opens in a new tab)
`_disposed`	`protected`	`boolean`	`false`	`RenderComponent`.`_disposed`	submodules/univer/packages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
`_forceDirty`	`protected`	`boolean`	`true`	`RenderComponent`.`_forceDirty`	submodules/univer/packages/engine-render/src/base-object.ts:89 (opens in a new tab)
`_oKey`	`protected`	`string`	`undefined`	`RenderComponent`.`_oKey`	submodules/univer/packages/engine-render/src/base-object.ts:86 (opens in a new tab)
`groupKey?`	`public`	`string`	`undefined`	`RenderComponent`.`groupKey`	submodules/univer/packages/engine-render/src/base-object.ts:59 (opens in a new tab)
`isInGroup`	`public`	`boolean`	`false`	`RenderComponent`.`isInGroup`	submodules/univer/packages/engine-render/src/base-object.ts:60 (opens in a new tab)
`objectType`	`public`	`ObjectType`	`ObjectType.UNKNOWN`	`RenderComponent`.`objectType`	submodules/univer/packages/engine-render/src/base-object.ts:62 (opens in a new tab)
`onDblclick$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`RenderComponent`.`onDblclick$`	submodules/univer/packages/engine-render/src/base-object.ts:74 (opens in a new tab)
`onDispose$`	`public`	`EventSubject`<`BaseObject`>	`undefined`	`RenderComponent`.`onDispose$`	submodules/univer/packages/engine-render/src/base-object.ts:84 (opens in a new tab)
`onDragEnter$`	`public`	`EventSubject`<`IMouseEvent` \| `IDragEvent`>	`undefined`	`RenderComponent`.`onDragEnter$`	submodules/univer/packages/engine-render/src/base-object.ts:80 (opens in a new tab)
`onDragLeave$`	`public`	`EventSubject`<`IMouseEvent` \| `IDragEvent`>	`undefined`	`RenderComponent`.`onDragLeave$`	submodules/univer/packages/engine-render/src/base-object.ts:78 (opens in a new tab)
`onDragOver$`	`public`	`EventSubject`<`IMouseEvent` \| `IDragEvent`>	`undefined`	`RenderComponent`.`onDragOver$`	submodules/univer/packages/engine-render/src/base-object.ts:79 (opens in a new tab)
`onDrop$`	`public`	`EventSubject`<`IMouseEvent` \| `IDragEvent`>	`undefined`	`RenderComponent`.`onDrop$`	submodules/univer/packages/engine-render/src/base-object.ts:81 (opens in a new tab)
`onIsAddedToParent$`	`public`	`EventSubject`<`any`>	`undefined`	`RenderComponent`.`onIsAddedToParent$`	submodules/univer/packages/engine-render/src/base-object.ts:83 (opens in a new tab)
`onMouseWheel$`	`public`	`EventSubject`<`IWheelEvent`>	`undefined`	`RenderComponent`.`onMouseWheel$`	submodules/univer/packages/engine-render/src/base-object.ts:76 (opens in a new tab)
`onPointerDown$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`RenderComponent`.`onPointerDown$`	submodules/univer/packages/engine-render/src/base-object.ts:66 (opens in a new tab)
`onPointerEnter$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`RenderComponent`.`onPointerEnter$`	submodules/univer/packages/engine-render/src/base-object.ts:72 (opens in a new tab)
`onPointerLeave$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`RenderComponent`.`onPointerLeave$`	submodules/univer/packages/engine-render/src/base-object.ts:71 (opens in a new tab)
`onPointerMove$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`RenderComponent`.`onPointerMove$`	submodules/univer/packages/engine-render/src/base-object.ts:67 (opens in a new tab)
`onPointerOut$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`RenderComponent`.`onPointerOut$`	submodules/univer/packages/engine-render/src/base-object.ts:69 (opens in a new tab)
`onPointerOver$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`RenderComponent`.`onPointerOver$`	submodules/univer/packages/engine-render/src/base-object.ts:70 (opens in a new tab)
`onPointerUp$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`RenderComponent`.`onPointerUp$`	submodules/univer/packages/engine-render/src/base-object.ts:68 (opens in a new tab)
`onTransformChange$`	`public`	`EventSubject`<`ITransformChangeState`>	`undefined`	`RenderComponent`.`onTransformChange$`	submodules/univer/packages/engine-render/src/base-object.ts:64 (opens in a new tab)
`onTripleClick$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`RenderComponent`.`onTripleClick$`	submodules/univer/packages/engine-render/src/base-object.ts:75 (opens in a new tab)

Accessors

ancestorGroup

get ancestorGroup(): Nullable<BaseObject>

Returns

Nullable<BaseObject>

Inherited from

RenderComponent.ancestorGroup

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:251 (opens in a new tab)

ancestorLeft

get ancestorLeft(): any

Returns

any

Inherited from

RenderComponent.ancestorLeft

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:235 (opens in a new tab)

ancestorScaleX

get ancestorScaleX(): number

Returns

number

Inherited from

RenderComponent.ancestorScaleX

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:225 (opens in a new tab)

ancestorScaleY

get ancestorScaleY(): number

Returns

number

Inherited from

RenderComponent.ancestorScaleY

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:230 (opens in a new tab)

ancestorTop

get ancestorTop(): any

Returns

any

Inherited from

RenderComponent.ancestorTop

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:239 (opens in a new tab)

ancestorTransform

get ancestorTransform(): any

Returns

any

Inherited from

RenderComponent.ancestorTransform

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:243 (opens in a new tab)

angle

get angle(): number

set angle(angle): void

Parameters

Parameter	Type
`angle`	`number`

Returns

number

Inherited from

RenderComponent.angle

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:213 (opens in a new tab)

classType

get classType(): RENDER_CLASS_TYPE

Returns

RENDER_CLASS_TYPE

Inherited from

RenderComponent.classType

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:189 (opens in a new tab)

cursor

get cursor(): CURSOR_TYPE

set cursor(val): void

Parameters

Parameter	Type
`val`	`CURSOR_TYPE`

Returns

CURSOR_TYPE

Inherited from

RenderComponent.cursor

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:303 (opens in a new tab)

debounceParentDirty

get debounceParentDirty(): boolean

set debounceParentDirty(state): void

Parameters

Parameter	Type
`state`	`boolean`

Returns

boolean

Inherited from

RenderComponent.debounceParentDirty

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:299 (opens in a new tab)

evented

get evented(): boolean

set evented(state): void

Parameters

Parameter	Type
`state`	`boolean`

Returns

boolean

Inherited from

RenderComponent.evented

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:291 (opens in a new tab)

extensions

get extensions(): Map<string, ComponentExtension<T, U, V>>

Returns

Map<string, ComponentExtension<T, U, V>>

Inherited from

RenderComponent.extensions

Defined in

submodules/univer/packages/engine-render/src/components/component.ts:27 (opens in a new tab)

flipX

get flipX(): boolean

set flipX(flipX): void

Parameters

Parameter	Type
`flipX`	`boolean`

Returns

boolean

Inherited from

RenderComponent.flipX

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:271 (opens in a new tab)

flipY

get flipY(): boolean

set flipY(flipY): void

Parameters

Parameter	Type
`flipY`	`boolean`

Returns

boolean

Inherited from

RenderComponent.flipY

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:275 (opens in a new tab)

height

get height(): number

set height(num): void

Parameters

Parameter	Type
`num`	`string` \| `number`

Returns

number

Inherited from

RenderComponent.height

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:205 (opens in a new tab)

heightOrigin

get heightOrigin(): string | number

Returns

string | number

Inherited from

RenderComponent.heightOrigin

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:185 (opens in a new tab)

layer

get layer(): Nullable<Layer>

set layer(layer): void

Parameters

Parameter	Type
`layer`	`Layer`

Returns

Nullable<Layer>

Inherited from

RenderComponent.layer

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:307 (opens in a new tab)

left

get left(): number

set left(num): void

Parameters

Parameter	Type
`num`	`string` \| `number`

Returns

number

Inherited from

RenderComponent.left

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:197 (opens in a new tab)

leftOrigin

get leftOrigin(): string | number

Returns

string | number

Inherited from

RenderComponent.leftOrigin

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:177 (opens in a new tab)

maxZIndex

get maxZIndex(): number

Returns

number

Inherited from

RenderComponent.maxZIndex

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:399 (opens in a new tab)

oKey

get oKey(): string

Returns

string

Inherited from

RenderComponent.oKey

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:283 (opens in a new tab)

parent

get parent(): any

set parent(o): void

Parameters

Parameter	Type
`o`	`any`

Returns

any

Inherited from

RenderComponent.parent

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:279 (opens in a new tab)

printable

get printable(): boolean

Returns

boolean

Inherited from

RenderComponent.printable

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:169 (opens in a new tab)

scaleX

get scaleX(): number

set scaleX(scaleX): void

Parameters

Parameter	Type
`scaleX`	`number`

Returns

number

Inherited from

RenderComponent.scaleX

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:217 (opens in a new tab)

scaleY

get scaleY(): number

set scaleY(scaleY): void

Parameters

Parameter	Type
`scaleY`	`number`

Returns

number

Inherited from

RenderComponent.scaleY

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:221 (opens in a new tab)

skewX

get skewX(): number

set skewX(skewX): void

Parameters

Parameter	Type
`skewX`	`number`

Returns

number

Inherited from

RenderComponent.skewX

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:263 (opens in a new tab)

skewY

get skewY(): number

set skewY(skewY): void

Parameters

Parameter	Type
`skewY`	`number`

Returns

number

Inherited from

RenderComponent.skewY

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:267 (opens in a new tab)

strokeWidth

get strokeWidth(): number

set strokeWidth(width): void

Parameters

Parameter	Type
`width`	`number`

Returns

number

Inherited from

RenderComponent.strokeWidth

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:209 (opens in a new tab)

top

get top(): number

set top(num): void

Parameters

Parameter	Type
`num`	`string` \| `number`

Returns

number

Inherited from

RenderComponent.top

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:193 (opens in a new tab)

topOrigin

get topOrigin(): string | number

Returns

string | number

Inherited from

RenderComponent.topOrigin

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:173 (opens in a new tab)

transform

get transform(): Transform

set transform(trans): void

Parameters

Parameter	Type
`trans`	`Transform`

Returns

Transform

Inherited from

RenderComponent.transform

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:148 (opens in a new tab)

transformerConfig

get transformerConfig(): ITransformerConfig

set transformerConfig(config): void

Parameters

Parameter	Type
`config`	`ITransformerConfig`

Returns

ITransformerConfig

Inherited from

RenderComponent.transformerConfig

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:391 (opens in a new tab)

visible

get visible(): boolean

Returns

boolean

Inherited from

RenderComponent.visible

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:295 (opens in a new tab)

width

get width(): number

set width(num): void

Parameters

Parameter	Type
`num`	`string` \| `number`

Returns

number

Inherited from

RenderComponent.width

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:201 (opens in a new tab)

widthOrigin

get widthOrigin(): string | number

Returns

string | number

Inherited from

RenderComponent.widthOrigin

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:181 (opens in a new tab)

zIndex

get zIndex(): number

set zIndex(index): void

Parameters

Parameter	Type
`index`	`number`

Returns

number

Inherited from

RenderComponent.zIndex

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:287 (opens in a new tab)

Methods

_draw()

abstract protected _draw(ctx, bounds?): void

Parameters

Parameter	Type
`ctx`	`UniverRenderingContext`
`bounds`?	`IViewportInfo`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:85 (opens in a new tab)

_setTransForm()

protected _setTransForm(): void

Returns

void

Inherited from

RenderComponent._setTransForm

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:858 (opens in a new tab)

applyTransform()

applyTransform(): void

Returns

void

Inherited from

RenderComponent.applyTransform

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:846 (opens in a new tab)

dispose()

dispose(): void

TODO: DR-Univer, fix as unknown as

Returns

void

Overrides

RenderComponent.dispose

Defined in

submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:90 (opens in a new tab)

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

RenderComponent.disposeWithMe

Defined in

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

draw()

draw(ctx, bounds?): void

Parameters

Parameter	Type
`ctx`	`UniverRenderingContext`
`bounds`?	`IViewportInfo`

Returns

void

Inherited from

RenderComponent.draw

Defined in

submodules/univer/packages/engine-render/src/components/component.ts:61 (opens in a new tab)

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

RenderComponent.ensureNotDisposed

Defined in

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

flip()

flip(flipX?, flipY?): SheetComponent

Parameters

Parameter	Type
`flipX`?	`boolean`
`flipY`?	`boolean`

Returns

SheetComponent

Inherited from

RenderComponent.flip

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:522 (opens in a new tab)

getDocuments()

abstract getDocuments(): any

Returns

any

Defined in

submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:67 (opens in a new tab)

getEngine()

getEngine(): Nullable<Engine>

Returns

Nullable<Engine>

Inherited from

RenderComponent.getEngine

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:824 (opens in a new tab)

getExtensionByKey()

getExtensionByKey(uKey): undefined | ComponentExtension<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]>

Parameters

Parameter	Type
`uKey`	`string`

Returns

undefined | ComponentExtension<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]>

Inherited from

RenderComponent.getExtensionByKey

Defined in

submodules/univer/packages/engine-render/src/components/component.ts:57 (opens in a new tab)

getExtensionsByOrder()

getExtensionsByOrder(): ComponentExtension<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]>[]

Returns

ComponentExtension<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]>[]

Inherited from

RenderComponent.getExtensionsByOrder

Defined in

submodules/univer/packages/engine-render/src/components/component.ts:50 (opens in a new tab)

getInverseCoord()

getInverseCoord(coord): Vector2

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

Vector2

Inherited from

RenderComponent.getInverseCoord

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:854 (opens in a new tab)

getLayerIndex()

getLayerIndex(): number

Returns

number

Inherited from

RenderComponent.getLayerIndex

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:839 (opens in a new tab)

getNoMergeCellPositionByIndex()

abstract getNoMergeCellPositionByIndex(rowIndex, columnIndex): Nullable<{
  endX: number;
  endY: number;
  startX: number;
  startY: number;
}>

Parameters

Parameter	Type
`rowIndex`	`number`
`columnIndex`	`number`

Returns

Nullable<{ endX: number; endY: number; startX: number; startY: number; }>

Name	Type	Defined in
`endX`	`number`	submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:72 (opens in a new tab)
`endY`	`number`	submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:72 (opens in a new tab)
`startX`	`number`	submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:72 (opens in a new tab)
`startY`	`number`	submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:72 (opens in a new tab)

Defined in

submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:69 (opens in a new tab)

getObjects()

getObjects(): BaseObject[]

Returns

BaseObject[]

Inherited from

RenderComponent.getObjects

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:835 (opens in a new tab)

getParent()

getParent(): any

Returns

any

Inherited from

RenderComponent.getParent

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:580 (opens in a new tab)

getParentScale()

getParentScale(): {
  scaleX: number;
  scaleY: number;
}

Returns

{
  scaleX: number;
  scaleY: number;
}

Name	Type	Defined in
`scaleX`	`number`	submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:62 (opens in a new tab)
`scaleY`	`number`	submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:63 (opens in a new tab)

Defined in

submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:53 (opens in a new tab)

getScene()

getScene(): Nullable<Scene>

Returns

Nullable<Scene>

Inherited from

RenderComponent.getScene

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:796 (opens in a new tab)

getScrollXYByRelativeCoords()

getScrollXYByRelativeCoords(coord): {
  x: 0;
  y: 0;
}

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

{
  x: 0;
  y: 0;
}

Name	Type	Default value	Defined in
`x`	`number`	0	submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:75 (opens in a new tab)
`y`	`number`	0	submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:75 (opens in a new tab)

Defined in

submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:74 (opens in a new tab)

getSelectionBounding()

abstract getSelectionBounding(
   startRow, 
   startColumn, 
   endRow, 
   endColumn): Nullable<{
  endColumn: number;
  endRow: number;
  startColumn: number;
  startRow: number;
}>

Parameters

Parameter	Type
`startRow`	`number`
`startColumn`	`number`
`endRow`	`number`
`endColumn`	`number`

Returns

Nullable<{ endColumn: number; endRow: number; startColumn: number; startRow: number; }>

Name	Type	Defined in
`endColumn`	`number`	submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:83 (opens in a new tab)
`endRow`	`number`	submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:83 (opens in a new tab)
`startColumn`	`number`	submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:83 (opens in a new tab)
`startRow`	`number`	submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:83 (opens in a new tab)

Defined in

submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:78 (opens in a new tab)

getSkeleton()

getSkeleton(): undefined | SpreadsheetSkeleton

Returns

undefined | SpreadsheetSkeleton

Defined in

submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:34 (opens in a new tab)

getState()

getState(): ITransformState

Returns

ITransformState

Inherited from

RenderComponent.getState

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:584 (opens in a new tab)

hide()

hide(): void

Returns

void

Inherited from

RenderComponent.hide

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:600 (opens in a new tab)

isDirty()

isDirty(): boolean

Returns

boolean

Inherited from

RenderComponent.isDirty

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:431 (opens in a new tab)

isHit()

isHit(coord): boolean

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

boolean

Inherited from

RenderComponent.isHit

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:614 (opens in a new tab)

isRender()

isRender(bounds?): undefined | boolean

Parameters

Parameter	Type
`bounds`?	`IViewportInfo`

Returns

undefined | boolean

Inherited from

RenderComponent.isRender

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:573 (opens in a new tab)

makeDirty()

makeDirty(state): undefined | SheetComponent

Parameters

Parameter	Type	Default value
`state`	`boolean`	`true`

Returns

undefined | SheetComponent

Inherited from

RenderComponent.makeDirty

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:403 (opens in a new tab)

makeDirtyNoDebounce()

makeDirtyNoDebounce(state): SheetComponent

Parameters

Parameter	Type	Default value
`state`	`boolean`	`true`

Returns

SheetComponent

Inherited from

RenderComponent.makeDirtyNoDebounce

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:422 (opens in a new tab)

makeForceDirty()

makeForceDirty(state): void

Parameters

Parameter	Type	Default value
`state`	`boolean`	`true`

Returns

void

Inherited from

RenderComponent.makeForceDirty

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:418 (opens in a new tab)

register()

register(...extensions): IDisposable

Parameters

Parameter	Type
...`extensions`	`ComponentExtension`<`SpreadsheetSkeleton`, `SHEET_EXTENSION_TYPE`, `IRange`[]>[]

Returns

IDisposable

Inherited from

RenderComponent.register

Defined in

submodules/univer/packages/engine-render/src/components/component.ts:31 (opens in a new tab)

removeTransform()

removeTransform(): void

Returns

void

Inherited from

RenderComponent.removeTransform

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:850 (opens in a new tab)

render()

render(mainCtx, bounds?): undefined | SheetComponent

Parameters

Parameter	Type
`mainCtx`	`UniverRenderingContext`
`bounds`?	`IViewportInfo`

Returns

undefined | SheetComponent

Overrides

RenderComponent.render

Defined in

submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:42 (opens in a new tab)

resetCursor()

resetCursor(): void

Returns

void

Inherited from

RenderComponent.resetCursor

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:815 (opens in a new tab)

resize()

resize(width?, height?): SheetComponent

Parameters

Parameter	Type
`width`?	`string` \| `number`
`height`?	`string` \| `number`

Returns

SheetComponent

Inherited from

RenderComponent.resize

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:457 (opens in a new tab)

scale()

scale(scaleX?, scaleY?): SheetComponent

Parameters

Parameter	Type
`scaleX`?	`number`
`scaleY`?	`number`

Returns

SheetComponent

Inherited from

RenderComponent.scale

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:478 (opens in a new tab)

setCursor()

setCursor(val): void

Parameters

Parameter	Type
`val`	`CURSOR_TYPE`

Returns

void

Inherited from

RenderComponent.setCursor

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:819 (opens in a new tab)

show()

show(): void

Returns

void

Inherited from

RenderComponent.show

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:605 (opens in a new tab)

skew()

skew(skewX?, skewY?): SheetComponent

Parameters

Parameter	Type
`skewX`?	`number`
`skewY`?	`number`

Returns

SheetComponent

Inherited from

RenderComponent.skew

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:500 (opens in a new tab)

toJson()

toJson(): IKeyValue

Returns

IKeyValue

Inherited from

RenderComponent.toJson

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:785 (opens in a new tab)

transformByState()

transformByState(option): undefined | SheetComponent

this[pKey] = option[pKey]

Parameters

Parameter	Type
`option`	`IObjectFullState`

Returns

undefined | SheetComponent

Inherited from

RenderComponent.transformByState

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:547 (opens in a new tab)

transformForAngle()

transformForAngle(transform): Transform

Parameters

Parameter	Type
`transform`	`Transform`

Returns

Transform

Inherited from

RenderComponent.transformForAngle

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:153 (opens in a new tab)

translate()

translate(x?, y?): SheetComponent

Parameters

Parameter	Type
`x`?	`string` \| `number`
`y`?	`string` \| `number`

Returns

SheetComponent

Inherited from

RenderComponent.translate

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:435 (opens in a new tab)

triggerDblclick()

triggerDblclick(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

RenderComponent.triggerDblclick

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:651 (opens in a new tab)

triggerDragEnter()

triggerDragEnter(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IDragEvent`

Returns

boolean

Inherited from

RenderComponent.triggerDragEnter

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:737 (opens in a new tab)

triggerDragLeave()

triggerDragLeave(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IDragEvent`

Returns

boolean

Inherited from

RenderComponent.triggerDragLeave

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:721 (opens in a new tab)

triggerDragOver()

triggerDragOver(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IDragEvent`

Returns

boolean

Inherited from

RenderComponent.triggerDragOver

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:729 (opens in a new tab)

triggerDrop()

triggerDrop(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IDragEvent`

Returns

boolean

Inherited from

RenderComponent.triggerDrop

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:745 (opens in a new tab)

triggerMouseWheel()

triggerMouseWheel(evt): boolean

Parameters

Parameter	Type
`evt`	`IWheelEvent`

Returns

boolean

Inherited from

RenderComponent.triggerMouseWheel

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:671 (opens in a new tab)

triggerPointerDown()

triggerPointerDown(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

RenderComponent.triggerPointerDown

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:635 (opens in a new tab)

triggerPointerEnter()

triggerPointerEnter(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

RenderComponent.triggerPointerEnter

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:713 (opens in a new tab)

triggerPointerLeave()

triggerPointerLeave(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

RenderComponent.triggerPointerLeave

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:697 (opens in a new tab)

triggerPointerMove()

triggerPointerMove(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

RenderComponent.triggerPointerMove

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:627 (opens in a new tab)

triggerPointerOut()

triggerPointerOut(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

RenderComponent.triggerPointerOut

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:689 (opens in a new tab)

triggerPointerOver()

triggerPointerOver(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

RenderComponent.triggerPointerOver

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:705 (opens in a new tab)

triggerPointerUp()

triggerPointerUp(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

RenderComponent.triggerPointerUp

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:643 (opens in a new tab)

triggerTripleClick()

triggerTripleClick(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

RenderComponent.triggerTripleClick

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:661 (opens in a new tab)

updateSkeleton()

updateSkeleton(spreadsheetSkeleton): void

Parameters

Parameter	Type
`spreadsheetSkeleton`	`SpreadsheetSkeleton`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:38 (opens in a new tab)

Shape Sheetextension

Class: abstract SheetComponent

Extends

Extended by

Constructors

new SheetComponent()

Parameters

Returns

Overrides

Defined in

Properties

Accessors

ancestorGroup

Returns

Inherited from

Defined in

ancestorLeft

Returns

Inherited from

Defined in

ancestorScaleX

Returns

Inherited from

Defined in

ancestorScaleY

Returns

Inherited from

Defined in

ancestorTop

Returns

Inherited from

Defined in

ancestorTransform

Returns

Inherited from

Defined in

angle

Parameters

Returns

Inherited from

Defined in

classType

Returns

Inherited from

Defined in

cursor

Parameters

Returns

Inherited from

Defined in

debounceParentDirty

Parameters

Returns

Inherited from

Defined in

evented

Parameters

Returns

Inherited from

Defined in

extensions

Returns

Inherited from

Defined in

flipX

Parameters

Returns

Inherited from

Defined in

flipY

Parameters

Returns

Inherited from

Defined in

height

Parameters

Returns

Inherited from

Defined in

heightOrigin

Returns

Class: `abstract` SheetComponent