@univerjs/engine-render v0.1.17 • Docs

Class: abstract SheetComponent

Extends

• RenderComponent<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]>

Extended by

• SpreadsheetHeader
• Spreadsheet

Constructors

new SheetComponent()

new SheetComponent(oKey, _skeleton?): SheetComponent

Parameters

Returns

SheetComponent

Overrides

RenderComponent.constructor

Defined in

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

Properties

Accessors

ancestorGroup

get ancestorGroup(): Nullable<BaseObject>

Returns

Nullable<BaseObject>

Inherited from

RenderComponent.ancestorGroup

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:237 (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:221 (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:211 (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:216 (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:225 (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:229 (opens in a new tab)

angle

get angle(): number

set angle(angle): void

Parameters

Returns

number

Inherited from

RenderComponent.angle

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:199 (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:175 (opens in a new tab)

cursor

get cursor(): CURSOR_TYPE

set cursor(val): void

Parameters

Returns

CURSOR_TYPE

Inherited from

RenderComponent.cursor

Defined in

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

debounceParentDirty

get debounceParentDirty(): boolean

set debounceParentDirty(state): void

Parameters

Returns

boolean

Inherited from

RenderComponent.debounceParentDirty

Defined in

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

evented

get evented(): boolean

set evented(state): void

Parameters

Returns

boolean

Inherited from

RenderComponent.evented

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:277 (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

Returns

boolean

Inherited from

RenderComponent.flipX

Defined in

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

flipY

get flipY(): boolean

set flipY(flipY): void

Parameters

Returns

boolean

Inherited from

RenderComponent.flipY

Defined in

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

height

get height(): number

set height(num): void

Parameters

Returns

number

Inherited from

RenderComponent.height

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:191 (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:171 (opens in a new tab)

layer

get layer(): Nullable<Layer>

set layer(layer): void

Parameters

Returns

Nullable<Layer>

Inherited from

RenderComponent.layer

Defined in

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

left

get left(): number

set left(num): void

Parameters

Returns

number

Inherited from

RenderComponent.left

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:183 (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:163 (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:385 (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:269 (opens in a new tab)

parent

get parent(): any

set parent(o): void

Parameters

Returns

any

Inherited from

RenderComponent.parent

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:265 (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:155 (opens in a new tab)

scaleX

get scaleX(): number

set scaleX(scaleX): void

Parameters

Returns

number

Inherited from

RenderComponent.scaleX

Defined in

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

scaleY

get scaleY(): number

set scaleY(scaleY): void

Parameters

Returns

number

Inherited from

RenderComponent.scaleY

Defined in

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

skewX

get skewX(): number

set skewX(skewX): void

Parameters

Returns

number

Inherited from

RenderComponent.skewX

Defined in

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

skewY

get skewY(): number

set skewY(skewY): void

Parameters

Returns

number

Inherited from

RenderComponent.skewY

Defined in

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

strokeWidth

get strokeWidth(): number

set strokeWidth(width): void

Parameters

Returns

number

Inherited from

RenderComponent.strokeWidth

Defined in

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

top

get top(): number

set top(num): void

Parameters

Returns

number

Inherited from

RenderComponent.top

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:179 (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:159 (opens in a new tab)

transform

get transform(): Transform

set transform(trans): void

Parameters

Returns

Transform

Inherited from

RenderComponent.transform

Defined in

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

transformerConfig

get transformerConfig(): ITransformerConfig

set transformerConfig(config): void

Parameters

Returns

ITransformerConfig

Inherited from

RenderComponent.transformerConfig

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:377 (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:281 (opens in a new tab)

width

get width(): number

set width(num): void

Parameters

Returns

number

Inherited from

RenderComponent.width

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:187 (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:167 (opens in a new tab)

zIndex

get zIndex(): number

set zIndex(index): void

Parameters

Returns

number

Inherited from

RenderComponent.zIndex

Defined in

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

Methods

_draw()

abstract protected _draw(ctx, bounds?): void

Parameters

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:840 (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:828 (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()

protected disposeWithMe(disposable): IDisposable

Parameters

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

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

Returns

SheetComponent

Inherited from

RenderComponent.flip

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:508 (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(): any

Returns

any

Inherited from

RenderComponent.getEngine

Defined in

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

getExtensionByKey()

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

Parameters

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

Returns

Vector2

Inherited from

RenderComponent.getInverseCoord

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:836 (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:821 (opens in a new tab)

getNoMergeCellPositionByIndex()

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

Parameters

Returns

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

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:817 (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:562 (opens in a new tab)

getParentScale()

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

Returns

{
  scaleX: number;
  scaleY: number;
}

Defined in

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

getScene()

getScene(): any

Returns

any

Inherited from

RenderComponent.getScene

Defined in

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

getScrollXYByRelativeCoords()

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

Parameters

Returns

{
  x: 0;
  y: 0;
}

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

Returns

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

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:566 (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:582 (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:417 (opens in a new tab)

isHit()

isHit(coord): boolean

Parameters

Returns

boolean

Inherited from

RenderComponent.isHit

Defined in

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

isRender()

isRender(bounds?): undefined | boolean

Parameters

Returns

undefined | boolean

Inherited from

RenderComponent.isRender

Defined in

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

makeDirty()

makeDirty(state): undefined | SheetComponent

Parameters

Returns

undefined | SheetComponent

Inherited from

RenderComponent.makeDirty

Defined in

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

makeDirtyNoDebounce()

makeDirtyNoDebounce(state): SheetComponent

Parameters

Returns

SheetComponent

Inherited from

RenderComponent.makeDirtyNoDebounce

Defined in

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

makeForceDirty()

makeForceDirty(state): void

Parameters

Returns

void

Inherited from

RenderComponent.makeForceDirty

Defined in

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

register()

register(...extensions): IDisposable

Parameters

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:832 (opens in a new tab)

render()

render(mainCtx, bounds?): undefined | SheetComponent

Parameters

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:797 (opens in a new tab)

resize()

resize(width?, height?): SheetComponent

Parameters

Returns

SheetComponent

Inherited from

RenderComponent.resize

Defined in

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

scale()

scale(scaleX?, scaleY?): SheetComponent

Parameters

Returns

SheetComponent

Inherited from

RenderComponent.scale

Defined in

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

setCursor()

setCursor(val): void

Parameters

Returns

void

Inherited from

RenderComponent.setCursor

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:801 (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:587 (opens in a new tab)

skew()

skew(skewX?, skewY?): SheetComponent

Parameters

Returns

SheetComponent

Inherited from

RenderComponent.skew

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:486 (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:767 (opens in a new tab)

transformByState()

transformByState(option): undefined | SheetComponent

Parameters

Returns

undefined | SheetComponent

Inherited from

RenderComponent.transformByState

Defined in

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

transformForAngle()

transformForAngle(transform): Transform

Parameters

Returns

Transform

Inherited from

RenderComponent.transformForAngle

Defined in

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

translate()

translate(x?, y?): SheetComponent

Parameters

Returns

SheetComponent

Inherited from

RenderComponent.translate

Defined in

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

triggerDblclick()

triggerDblclick(evt): boolean

Parameters

Returns

boolean

Inherited from

RenderComponent.triggerDblclick

Defined in

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

triggerDragEnter()

triggerDragEnter(evt): boolean

Parameters

Returns

boolean

Inherited from

RenderComponent.triggerDragEnter

Defined in

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

triggerDragLeave()

triggerDragLeave(evt): boolean

Parameters

Returns

boolean

Inherited from

RenderComponent.triggerDragLeave

Defined in

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

triggerDragOver()

triggerDragOver(evt): boolean

Parameters

Returns

boolean

Inherited from

RenderComponent.triggerDragOver

Defined in

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

triggerDrop()

triggerDrop(evt): boolean

Parameters

Returns

boolean

Inherited from

RenderComponent.triggerDrop

Defined in

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

triggerMouseWheel()

triggerMouseWheel(evt): boolean

Parameters

Returns

boolean

Inherited from

RenderComponent.triggerMouseWheel

Defined in

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

triggerPointerDown()

triggerPointerDown(evt): boolean

Parameters

Returns

boolean

Inherited from

RenderComponent.triggerPointerDown

Defined in

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

triggerPointerEnter()

triggerPointerEnter(evt): boolean

Parameters

Returns

boolean

Inherited from

RenderComponent.triggerPointerEnter

Defined in

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

triggerPointerLeave()

triggerPointerLeave(evt): boolean

Parameters

Returns

boolean

Inherited from

RenderComponent.triggerPointerLeave

Defined in

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

triggerPointerMove()

triggerPointerMove(evt): boolean

Parameters

Returns

boolean

Inherited from

RenderComponent.triggerPointerMove

Defined in

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

triggerPointerOut()

triggerPointerOut(evt): boolean

Parameters

Returns

boolean

Inherited from

RenderComponent.triggerPointerOut

Defined in

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

triggerPointerOver()

triggerPointerOver(evt): boolean

Parameters

Returns

boolean

Inherited from

RenderComponent.triggerPointerOver

Defined in

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

triggerPointerUp()

triggerPointerUp(evt): boolean

Parameters

Returns

boolean

Inherited from

RenderComponent.triggerPointerUp

Defined in

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

triggerTripleClick()

triggerTripleClick(evt): boolean

Parameters

Returns

boolean

Inherited from

RenderComponent.triggerTripleClick

Defined in

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

updateSkeleton()

updateSkeleton(spreadsheetSkeleton): void

Parameters

Returns

void

Defined in

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