Class: `abstract` SheetComponent

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:26

Extends

RenderComponent<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]>

Extended by

Constructors

new SheetComponent()

new SheetComponent(oKey, _skeleton?): SheetComponent

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:27

Parameters

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

Returns

SheetComponent

Overrides

RenderComponent.constructor

Properties

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

Accessors

ancestorGroup

Get Signature

get ancestorGroup(): Nullable<BaseObject>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:251

Returns

Nullable<BaseObject>

Inherited from

RenderComponent.ancestorGroup

ancestorLeft

Get Signature

get ancestorLeft(): any

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:235

Returns

any

Inherited from

RenderComponent.ancestorLeft

ancestorScaleX

Get Signature

get ancestorScaleX(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:225

Returns

number

Inherited from

RenderComponent.ancestorScaleX

ancestorScaleY

Get Signature

get ancestorScaleY(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:230

Returns

number

Inherited from

RenderComponent.ancestorScaleY

ancestorTop

Get Signature

get ancestorTop(): any

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:239

Returns

any

Inherited from

RenderComponent.ancestorTop

ancestorTransform

Get Signature

get ancestorTransform(): any

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:243

Returns

any

Inherited from

RenderComponent.ancestorTransform

angle

Get Signature

get angle(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:213

Returns

number

Set Signature

set angle(angle): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:363

Parameters

Parameter	Type
`angle`	`number`

Returns

void

Inherited from

RenderComponent.angle

classType

Get Signature

get classType(): RENDER_CLASS_TYPE

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:189

Returns

RENDER_CLASS_TYPE

Inherited from

RenderComponent.classType

cursor

Get Signature

get cursor(): CURSOR_TYPE

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:303

Returns

CURSOR_TYPE

Set Signature

set cursor(val): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:331

Parameters

Parameter	Type
`val`	`CURSOR_TYPE`

Returns

void

Inherited from

RenderComponent.cursor

debounceParentDirty

Get Signature

get debounceParentDirty(): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:299

Returns

boolean

Set Signature

set debounceParentDirty(state): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:327

Parameters

Parameter	Type
`state`	`boolean`

Returns

void

Inherited from

RenderComponent.debounceParentDirty

evented

Get Signature

get evented(): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:291

Returns

boolean

Set Signature

set evented(state): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:323

Parameters

Parameter	Type
`state`	`boolean`

Returns

void

Inherited from

RenderComponent.evented

extensions

Get Signature

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

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/component.ts:27

Returns

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

Inherited from

RenderComponent.extensions

flipX

Get Signature

get flipX(): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:271

Returns

boolean

Set Signature

set flipX(flipX): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:383

Parameters

Parameter	Type
`flipX`	`boolean`

Returns

void

Inherited from

RenderComponent.flipX

flipY

Get Signature

get flipY(): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:275

Returns

boolean

Set Signature

set flipY(flipY): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:379

Parameters

Parameter	Type
`flipY`	`boolean`

Returns

void

Inherited from

RenderComponent.flipY

height

Get Signature

get height(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:205

Returns

number

Set Signature

set height(num): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:354

Parameters

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

Returns

void

Inherited from

RenderComponent.height

heightOrigin

Get Signature

get heightOrigin(): string | number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:185

Returns

string | number

Inherited from

RenderComponent.heightOrigin

layer

Get Signature

get layer(): Nullable<Layer>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:307

Returns

Nullable<Layer>

Set Signature

set layer(layer): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:335

Parameters

Parameter	Type
`layer`	`Layer`

Returns

void

Inherited from

RenderComponent.layer

left

Get Signature

get left(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:197

Returns

number

Set Signature

set left(num): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:344

Parameters

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

Returns

void

Inherited from

RenderComponent.left

leftOrigin

Get Signature

get leftOrigin(): string | number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:177

Returns

string | number

Inherited from

RenderComponent.leftOrigin

maxZIndex

Get Signature

get maxZIndex(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:399

Returns

number

Inherited from

RenderComponent.maxZIndex

oKey

Get Signature

get oKey(): string

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:283

Returns

string

Inherited from

RenderComponent.oKey

parent

Get Signature

get parent(): any

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:279

Returns

any

Set Signature

set parent(o): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:319

Parameters

Parameter	Type
`o`	`any`

Returns

void

Inherited from

RenderComponent.parent

printable

Get Signature

get printable(): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:169

Returns

boolean

Inherited from

RenderComponent.printable

scaleX

Get Signature

get scaleX(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:217

Returns

number

Set Signature

set scaleX(scaleX): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:367

Parameters

Parameter	Type
`scaleX`	`number`

Returns

void

Inherited from

RenderComponent.scaleX

scaleY

Get Signature

get scaleY(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:221

Returns

number

Set Signature

set scaleY(scaleY): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:371

Parameters

Parameter	Type
`scaleY`	`number`

Returns

void

Inherited from

RenderComponent.scaleY

skewX

Get Signature

get skewX(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:263

Returns

number

Set Signature

set skewX(skewX): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:375

Parameters

Parameter	Type
`skewX`	`number`

Returns

void

Inherited from

RenderComponent.skewX

skewY

Get Signature

get skewY(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:267

Returns

number

Set Signature

set skewY(skewY): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:387

Parameters

Parameter	Type
`skewY`	`number`

Returns

void

Inherited from

RenderComponent.skewY

strokeWidth

Get Signature

get strokeWidth(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:209

Returns

number

Set Signature

set strokeWidth(width): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:359

Parameters

Parameter	Type
`width`	`number`

Returns

void

Inherited from

RenderComponent.strokeWidth

top

Get Signature

get top(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:193

Returns

number

Set Signature

set top(num): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:339

Parameters

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

Returns

void

Inherited from

RenderComponent.top

topOrigin

Get Signature

get topOrigin(): string | number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:173

Returns

string | number

Inherited from

RenderComponent.topOrigin

transform

Get Signature

get transform(): Transform

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:148

Returns

Transform

Set Signature

set transform(trans): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:311

Parameters

Parameter	Type
`trans`	`Transform`

Returns

void

Inherited from

RenderComponent.transform

transformerConfig

Get Signature

get transformerConfig(): ITransformerConfig

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:391

Returns

ITransformerConfig

Set Signature

set transformerConfig(config): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:395

Parameters

Parameter	Type
`config`	`ITransformerConfig`

Returns

void

Inherited from

RenderComponent.transformerConfig

visible

Get Signature

get visible(): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:295

Returns

boolean

Inherited from

RenderComponent.visible

width

Get Signature

get width(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:201

Returns

number

Set Signature

set width(num): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:349

Parameters

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

Returns

void

Inherited from

RenderComponent.width

widthOrigin

Get Signature

get widthOrigin(): string | number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:181

Returns

string | number

Inherited from

RenderComponent.widthOrigin

zIndex

Get Signature

get zIndex(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:287

Returns

number

Set Signature

set zIndex(index): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:315

Parameters

Parameter	Type
`index`	`number`

Returns

void

Inherited from

RenderComponent.zIndex

Methods

_draw()

abstract protected _draw(ctx, bounds?): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:86

Parameters

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

Returns

void

_setTransForm()

protected _setTransForm(): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:849

Returns

void

Inherited from

RenderComponent._setTransForm

applyTransform()

applyTransform(): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:837

Returns

void

Inherited from

RenderComponent.applyTransform

dispose()

dispose(): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:91

TODO: DR-Univer, fix as unknown as

Returns

void

Overrides

RenderComponent.dispose

disposeWithMe()

disposeWithMe(disposable): IDisposable

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:99

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

RenderComponent.disposeWithMe

draw()

draw(ctx, bounds?): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/component.ts:61

Parameters

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

Returns

void

Inherited from

RenderComponent.draw

ensureNotDisposed()

protected ensureNotDisposed(): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:103

Returns

void

Inherited from

RenderComponent.ensureNotDisposed

flip()

flip(flipX?, flipY?): SheetComponent

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:522

Parameters

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

Returns

SheetComponent

Inherited from

RenderComponent.flip

getDocuments()

abstract getDocuments(): any

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:68

Returns

any

getEngine()

getEngine(): Nullable<Engine>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:815

Returns

Nullable<Engine>

Inherited from

RenderComponent.getEngine

getExtensionByKey()

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

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/component.ts:57

Parameters

Parameter	Type
`uKey`	`string`

Returns

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

Inherited from

RenderComponent.getExtensionByKey

getExtensionsByOrder()

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

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/component.ts:50

Returns

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

Inherited from

RenderComponent.getExtensionsByOrder

getInverseCoord()

getInverseCoord(coord): Vector2

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:845

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

Vector2

Inherited from

RenderComponent.getInverseCoord

getLayerIndex()

getLayerIndex(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:830

Returns

number

Inherited from

RenderComponent.getLayerIndex

getNoMergeCellPositionByIndex()

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

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:70

Parameters

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

Returns

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

getObjects()

getObjects(): BaseObject[]

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:826

Returns

BaseObject[]

Inherited from

RenderComponent.getObjects

getParent()

getParent(): any

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:580

Returns

any

Inherited from

RenderComponent.getParent

getParentScale()

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

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:54

Returns

{
  scaleX: number;
  scaleY: number;
}

Name	Type	Defined in
`scaleX`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:63
`scaleY`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:64

getScene()

getScene(): Nullable<Scene>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:794

Returns

Nullable<Scene>

Inherited from

RenderComponent.getScene

getScrollXYByRelativeCoords()

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

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:75

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

{
  x: number;
  y: number;
}

Name	Type	Default value	Defined in
`x`	`number`	0	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:76
`y`	`number`	0	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:76

getSelectionBounding()

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

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:79

Parameters

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

Returns

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

getSkeleton()

getSkeleton(): undefined | SpreadsheetSkeleton

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:34

Returns

undefined | SpreadsheetSkeleton

getState()

getState(): ITransformState

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:584

Returns

ITransformState

Inherited from

RenderComponent.getState

hide()

hide(): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:600

Returns

void

Inherited from

RenderComponent.hide

isDirty()

isDirty(): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:431

Returns

boolean

Inherited from

RenderComponent.isDirty

isHit()

isHit(coord): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:614

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

boolean

Inherited from

RenderComponent.isHit

isRender()

isRender(bounds?): undefined | boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:573

Parameters

Parameter	Type
`bounds`?	`IViewportInfo`

Returns

undefined | boolean

Inherited from

RenderComponent.isRender

makeDirty()

makeDirty(state): undefined | SheetComponent

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:403

Parameters

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

Returns

undefined | SheetComponent

Inherited from

RenderComponent.makeDirty

makeDirtyNoDebounce()

makeDirtyNoDebounce(state): SheetComponent

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:422

Parameters

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

Returns

SheetComponent

Inherited from

RenderComponent.makeDirtyNoDebounce

makeForceDirty()

makeForceDirty(state): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:418

Parameters

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

Returns

void

Inherited from

RenderComponent.makeForceDirty

register()

register(...extensions): IDisposable

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/component.ts:31

Parameters

Parameter	Type
…`extensions`	`ComponentExtension`<`SpreadsheetSkeleton`, `GRID`, `IRange`[]>[]

Returns

IDisposable

Inherited from

RenderComponent.register

removeTransform()

removeTransform(): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:841

Returns

void

Inherited from

RenderComponent.removeTransform

render()

render(mainCtx, bounds?): undefined | SheetComponent

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:43

Parameters

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

Returns

undefined | SheetComponent

Overrides

RenderComponent.render

resetCursor()

resetCursor(): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:806

Returns

void

Inherited from

RenderComponent.resetCursor

resize()

resize(width?, height?): SheetComponent

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:457

Parameters

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

Returns

SheetComponent

Inherited from

RenderComponent.resize

scale()

scale(scaleX?, scaleY?): SheetComponent

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:478

Parameters

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

Returns

SheetComponent

Inherited from

RenderComponent.scale

setCursor()

setCursor(val): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:810

Parameters

Parameter	Type
`val`	`CURSOR_TYPE`

Returns

void

Inherited from

RenderComponent.setCursor

show()

show(): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:605

Returns

void

Inherited from

RenderComponent.show

skew()

skew(skewX?, skewY?): SheetComponent

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:500

Parameters

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

Returns

SheetComponent

Inherited from

RenderComponent.skew

toJson()

toJson(): IKeyValue

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:783

Returns

IKeyValue

Inherited from

RenderComponent.toJson

transformByState()

transformByState(option): undefined | SheetComponent

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:547

this[pKey] = option[pKey]

Parameters

Parameter	Type
`option`	`IObjectFullState`

Returns

undefined | SheetComponent

Inherited from

RenderComponent.transformByState

transformForAngle()

transformForAngle(transform): Transform

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:153

Parameters

Parameter	Type
`transform`	`Transform`

Returns

Transform

Inherited from

RenderComponent.transformForAngle

translate()

translate(x?, y?): SheetComponent

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:435

Parameters

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

Returns

SheetComponent

Inherited from

RenderComponent.translate

triggerDblclick()

triggerDblclick(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:651

Parameters

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

Returns

boolean

Inherited from

RenderComponent.triggerDblclick

triggerDragEnter()

triggerDragEnter(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:735

Parameters

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

Returns

boolean

Inherited from

RenderComponent.triggerDragEnter

triggerDragLeave()

triggerDragLeave(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:719

Parameters

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

Returns

boolean

Inherited from

RenderComponent.triggerDragLeave

triggerDragOver()

triggerDragOver(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:727

Parameters

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

Returns

boolean

Inherited from

RenderComponent.triggerDragOver

triggerDrop()

triggerDrop(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:743

Parameters

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

Returns

boolean

Inherited from

RenderComponent.triggerDrop

triggerMouseWheel()

triggerMouseWheel(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:671

Parameters

Parameter	Type
`evt`	`IWheelEvent`

Returns

boolean

Inherited from

RenderComponent.triggerMouseWheel

triggerPointerCancel()

triggerPointerCancel(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:711

Parameters

Parameter	Type
`evt`	`IPointerEvent`

Returns

boolean

Inherited from

RenderComponent.triggerPointerCancel

triggerPointerDown()

triggerPointerDown(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:635

Parameters

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

Returns

boolean

Inherited from

RenderComponent.triggerPointerDown

triggerPointerEnter()

triggerPointerEnter(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:703

Parameters

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

Returns

boolean

Inherited from

RenderComponent.triggerPointerEnter

triggerPointerLeave()

triggerPointerLeave(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:687

Parameters

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

Returns

boolean

Inherited from

RenderComponent.triggerPointerLeave

triggerPointerMove()

triggerPointerMove(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:627

Parameters

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

Returns

boolean

Inherited from

RenderComponent.triggerPointerMove

triggerPointerOut()

triggerPointerOut(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:679

Parameters

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

Returns

boolean

Inherited from

RenderComponent.triggerPointerOut

triggerPointerOver()

triggerPointerOver(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:695

Parameters

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

Returns

boolean

Inherited from

RenderComponent.triggerPointerOver

triggerPointerUp()

triggerPointerUp(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:643

Parameters

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

Returns

boolean

Inherited from

RenderComponent.triggerPointerUp

triggerTripleClick()

triggerTripleClick(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:661

Parameters

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

Returns

boolean

Inherited from

RenderComponent.triggerTripleClick

updateSkeleton()

updateSkeleton(spreadsheetSkeleton): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:38

Parameters

Parameter	Type
`spreadsheetSkeleton`	`SpreadsheetSkeleton`

Returns

void

Shape Sheetextension

Class: abstract SheetComponent

Extends

Extended by

Constructors

new SheetComponent()

Parameters

Returns

Overrides

Properties

Accessors

ancestorGroup

Get Signature

Returns

Inherited from

ancestorLeft

Get Signature

Returns

Inherited from

ancestorScaleX

Get Signature

Returns

Inherited from

ancestorScaleY

Get Signature

Returns

Inherited from

ancestorTop

Get Signature

Returns

Inherited from

ancestorTransform

Get Signature

Returns

Inherited from

angle

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

classType

Get Signature

Returns

Inherited from

cursor

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

debounceParentDirty

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

evented

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

extensions

Get Signature

Returns

Inherited from

flipX

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

flipY

Get Signature

Returns

Class: `abstract` SheetComponent