@univerjs/engine-render v0.5.4


Class: RenderComponent<T, U, V>

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

Extends

Extended by

Type Parameters

Type Parameter
T
U
V

Constructors

new RenderComponent()

new RenderComponent<T, U, V>(key?): RenderComponent<T, U, V>

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

Parameters

ParameterType
key?string

Returns

RenderComponent<T, U, V>

Inherited from

BaseObject.constructor

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_dirtyprotectedbooleantrueBaseObject._dirtypackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:88
_disposedprotectedbooleanfalseBaseObject._disposedpackages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:96
_forceDirtyprotectedbooleantrueBaseObject._forceDirtypackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:89
_oKeyprotectedstringundefinedBaseObject._oKeypackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:86
groupKey?publicstringundefinedBaseObject.groupKeypackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:59
isInGrouppublicbooleanfalseBaseObject.isInGrouppackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:60
objectTypepublicObjectTypeObjectType.UNKNOWNBaseObject.objectTypepackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:62
onDblclick$publicEventSubject< | IMouseEvent | IPointerEvent>undefinedBaseObject.onDblclick$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:74
onDispose$publicEventSubject<BaseObject>undefinedBaseObject.onDispose$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:84
onDragEnter$publicEventSubject< | IMouseEvent | IDragEvent>undefinedBaseObject.onDragEnter$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:80
onDragLeave$publicEventSubject< | IMouseEvent | IDragEvent>undefinedBaseObject.onDragLeave$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:78
onDragOver$publicEventSubject< | IMouseEvent | IDragEvent>undefinedBaseObject.onDragOver$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:79
onDrop$publicEventSubject< | IMouseEvent | IDragEvent>undefinedBaseObject.onDrop$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:81
onIsAddedToParent$publicEventSubject<any>undefinedBaseObject.onIsAddedToParent$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:83
onMouseWheel$publicEventSubject<IWheelEvent>undefinedBaseObject.onMouseWheel$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:76
onPointerDown$publicEventSubject< | IMouseEvent | IPointerEvent>undefinedBaseObject.onPointerDown$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:66
onPointerEnter$publicEventSubject< | IMouseEvent | IPointerEvent>undefinedBaseObject.onPointerEnter$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:72
onPointerLeave$publicEventSubject< | IMouseEvent | IPointerEvent>undefinedBaseObject.onPointerLeave$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:71
onPointerMove$publicEventSubject< | IMouseEvent | IPointerEvent>undefinedBaseObject.onPointerMove$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:67
onPointerOut$publicEventSubject< | IMouseEvent | IPointerEvent>undefinedBaseObject.onPointerOut$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:69
onPointerOver$publicEventSubject< | IMouseEvent | IPointerEvent>undefinedBaseObject.onPointerOver$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:70
onPointerUp$publicEventSubject< | IMouseEvent | IPointerEvent>undefinedBaseObject.onPointerUp$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:68
onTransformChange$publicEventSubject<ITransformChangeState>undefinedBaseObject.onTransformChange$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:64
onTripleClick$publicEventSubject< | IMouseEvent | IPointerEvent>undefinedBaseObject.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

BaseObject.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

BaseObject.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

BaseObject.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

BaseObject.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

BaseObject.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

BaseObject.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
ParameterType
anglenumber
Returns

void

Inherited from

BaseObject.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

BaseObject.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
ParameterType
valCURSOR_TYPE
Returns

void

Inherited from

BaseObject.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
ParameterType
stateboolean
Returns

void

Inherited from

BaseObject.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
ParameterType
stateboolean
Returns

void

Inherited from

BaseObject.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>>


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
ParameterType
flipXboolean
Returns

void

Inherited from

BaseObject.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
ParameterType
flipYboolean
Returns

void

Inherited from

BaseObject.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
ParameterType
numstring | number
Returns

void

Inherited from

BaseObject.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

BaseObject.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
ParameterType
layerLayer
Returns

void

Inherited from

BaseObject.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
ParameterType
numstring | number
Returns

void

Inherited from

BaseObject.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

BaseObject.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

BaseObject.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

BaseObject.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
ParameterType
oany
Returns

void

Inherited from

BaseObject.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

BaseObject.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
ParameterType
scaleXnumber
Returns

void

Inherited from

BaseObject.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
ParameterType
scaleYnumber
Returns

void

Inherited from

BaseObject.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
ParameterType
skewXnumber
Returns

void

Inherited from

BaseObject.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
ParameterType
skewYnumber
Returns

void

Inherited from

BaseObject.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
ParameterType
widthnumber
Returns

void

Inherited from

BaseObject.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
ParameterType
numstring | number
Returns

void

Inherited from

BaseObject.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

BaseObject.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
ParameterType
transTransform
Returns

void

Inherited from

BaseObject.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
ParameterType
configITransformerConfig
Returns

void

Inherited from

BaseObject.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

BaseObject.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
ParameterType
numstring | number
Returns

void

Inherited from

BaseObject.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

BaseObject.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
ParameterType
indexnumber
Returns

void

Inherited from

BaseObject.zIndex

Methods

_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

BaseObject._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

BaseObject.applyTransform


dispose()

dispose(): void

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

Returns

void

Overrides

BaseObject.dispose


disposeWithMe()

disposeWithMe(disposable): IDisposable

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

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

BaseObject.disposeWithMe


draw()

draw(ctx, bounds?): void

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

Parameters

ParameterType
ctxUniverRenderingContext
bounds?IViewportInfo

Returns

void


ensureNotDisposed()

protected ensureNotDisposed(): void

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

Returns

void

Inherited from

BaseObject.ensureNotDisposed


flip()

flip(flipX?, flipY?): RenderComponent<T, U, V>

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

Parameters

ParameterType
flipX?boolean
flipY?boolean

Returns

RenderComponent<T, U, V>

Inherited from

BaseObject.flip


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

BaseObject.getEngine


getExtensionByKey()

getExtensionByKey(uKey): 
  | undefined
| ComponentExtension<T, U, V>

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

Parameters

ParameterType
uKeystring

Returns

| undefined | ComponentExtension<T, U, V>


getExtensionsByOrder()

getExtensionsByOrder(): ComponentExtension<T, U, V>[]

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

Returns

ComponentExtension<T, U, V>[]


getInverseCoord()

getInverseCoord(coord): Vector2

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

Parameters

ParameterType
coordVector2

Returns

Vector2

Inherited from

BaseObject.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

BaseObject.getLayerIndex


getObjects()

getObjects(): BaseObject[]

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

Returns

BaseObject[]

Inherited from

BaseObject.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

BaseObject.getParent


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

BaseObject.getScene


getState()

getState(): ITransformState

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

Returns

ITransformState

Inherited from

BaseObject.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

BaseObject.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

BaseObject.isDirty


isHit()

isHit(coord): boolean

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

Parameters

ParameterType
coordVector2

Returns

boolean

Inherited from

BaseObject.isHit


isRender()

isRender(bounds?): undefined | boolean

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

Parameters

ParameterType
bounds?IViewportInfo

Returns

undefined | boolean

Inherited from

BaseObject.isRender


makeDirty()

makeDirty(state): undefined | RenderComponent<T, U, V>

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

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

undefined | RenderComponent<T, U, V>

Inherited from

BaseObject.makeDirty


makeDirtyNoDebounce()

makeDirtyNoDebounce(state): RenderComponent<T, U, V>

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

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

RenderComponent<T, U, V>

Inherited from

BaseObject.makeDirtyNoDebounce


makeForceDirty()

makeForceDirty(state): void

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

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

void

Inherited from

BaseObject.makeForceDirty


register()

register(...extensions): IDisposable

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

Parameters

ParameterType
extensionsComponentExtension<T, U, V>[]

Returns

IDisposable


removeTransform()

removeTransform(): void

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

Returns

void

Inherited from

BaseObject.removeTransform


render()

render(ctx, bounds): void

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

Parameters

ParameterType
ctxUniverRenderingContext
boundsIViewportInfo

Returns

void

Inherited from

BaseObject.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

BaseObject.resetCursor


resize()

resize(width?, height?): RenderComponent<T, U, V>

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

Parameters

ParameterType
width?string | number
height?string | number

Returns

RenderComponent<T, U, V>

Inherited from

BaseObject.resize


scale()

scale(scaleX?, scaleY?): RenderComponent<T, U, V>

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

Parameters

ParameterType
scaleX?number
scaleY?number

Returns

RenderComponent<T, U, V>

Inherited from

BaseObject.scale


setCursor()

setCursor(val): void

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

Parameters

ParameterType
valCURSOR_TYPE

Returns

void

Inherited from

BaseObject.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

BaseObject.show


skew()

skew(skewX?, skewY?): RenderComponent<T, U, V>

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

Parameters

ParameterType
skewX?number
skewY?number

Returns

RenderComponent<T, U, V>

Inherited from

BaseObject.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

BaseObject.toJson


transformByState()

transformByState(option): undefined | RenderComponent<T, U, V>

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

this[pKey] = option[pKey]

Parameters

ParameterType
optionIObjectFullState

Returns

undefined | RenderComponent<T, U, V>

Inherited from

BaseObject.transformByState


transformForAngle()

transformForAngle(transform): Transform

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

Parameters

ParameterType
transformTransform

Returns

Transform

Inherited from

BaseObject.transformForAngle


translate()

translate(x?, y?): RenderComponent<T, U, V>

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

Parameters

ParameterType
x?string | number
y?string | number

Returns

RenderComponent<T, U, V>

Inherited from

BaseObject.translate


triggerDblclick()

triggerDblclick(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerDblclick


triggerDragEnter()

triggerDragEnter(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IDragEvent

Returns

boolean

Inherited from

BaseObject.triggerDragEnter


triggerDragLeave()

triggerDragLeave(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IDragEvent

Returns

boolean

Inherited from

BaseObject.triggerDragLeave


triggerDragOver()

triggerDragOver(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IDragEvent

Returns

boolean

Inherited from

BaseObject.triggerDragOver


triggerDrop()

triggerDrop(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IDragEvent

Returns

boolean

Inherited from

BaseObject.triggerDrop


triggerMouseWheel()

triggerMouseWheel(evt): boolean

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

Parameters

ParameterType
evtIWheelEvent

Returns

boolean

Inherited from

BaseObject.triggerMouseWheel


triggerPointerCancel()

triggerPointerCancel(evt): boolean

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

Parameters

ParameterType
evtIPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerCancel


triggerPointerDown()

triggerPointerDown(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerDown


triggerPointerEnter()

triggerPointerEnter(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerEnter


triggerPointerLeave()

triggerPointerLeave(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerLeave


triggerPointerMove()

triggerPointerMove(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerMove


triggerPointerOut()

triggerPointerOut(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerOut


triggerPointerOver()

triggerPointerOver(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerOver


triggerPointerUp()

triggerPointerUp(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerUp


triggerTripleClick()

triggerTripleClick(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerTripleClick