@univerjs/engine-render v0.5.0-beta.1 • Docs


Class: CustomObject

Extends

Constructors

new CustomObject()

new CustomObject(
   key?, 
   _render?, 
   _isHitCustom?): CustomObject

Parameters

ParameterType
key?string
_render?(mainCtx) => void
_isHitCustom?(coord) => boolean

Returns

CustomObject

Overrides

BaseObject.constructor

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/custom/custom-object.ts:22

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:93
_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>
Returns

Nullable<BaseObject>

Inherited from

BaseObject.ancestorGroup

Defined in

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


ancestorLeft

Get Signature

get ancestorLeft(): any
Returns

any

Inherited from

BaseObject.ancestorLeft

Defined in

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


ancestorScaleX

Get Signature

get ancestorScaleX(): number
Returns

number

Inherited from

BaseObject.ancestorScaleX

Defined in

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


ancestorScaleY

Get Signature

get ancestorScaleY(): number
Returns

number

Inherited from

BaseObject.ancestorScaleY

Defined in

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


ancestorTop

Get Signature

get ancestorTop(): any
Returns

any

Inherited from

BaseObject.ancestorTop

Defined in

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


ancestorTransform

Get Signature

get ancestorTransform(): any
Returns

any

Inherited from

BaseObject.ancestorTransform

Defined in

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


angle

Get Signature

get angle(): number
Returns

number

Set Signature

set angle(angle): void
Parameters
ParameterType
anglenumber
Returns

void

Inherited from

BaseObject.angle

Defined in

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


classType

Get Signature

get classType(): RENDER_CLASS_TYPE
Returns

RENDER_CLASS_TYPE

Inherited from

BaseObject.classType

Defined in

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


cursor

Get Signature

get cursor(): CURSOR_TYPE
Returns

CURSOR_TYPE

Set Signature

set cursor(val): void
Parameters
ParameterType
valCURSOR_TYPE
Returns

void

Inherited from

BaseObject.cursor

Defined in

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


debounceParentDirty

Get Signature

get debounceParentDirty(): boolean
Returns

boolean

Set Signature

set debounceParentDirty(state): void
Parameters
ParameterType
stateboolean
Returns

void

Inherited from

BaseObject.debounceParentDirty

Defined in

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


evented

Get Signature

get evented(): boolean
Returns

boolean

Set Signature

set evented(state): void
Parameters
ParameterType
stateboolean
Returns

void

Inherited from

BaseObject.evented

Defined in

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


flipX

Get Signature

get flipX(): boolean
Returns

boolean

Set Signature

set flipX(flipX): void
Parameters
ParameterType
flipXboolean
Returns

void

Inherited from

BaseObject.flipX

Defined in

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


flipY

Get Signature

get flipY(): boolean
Returns

boolean

Set Signature

set flipY(flipY): void
Parameters
ParameterType
flipYboolean
Returns

void

Inherited from

BaseObject.flipY

Defined in

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


height

Get Signature

get height(): number
Returns

number

Set Signature

set height(num): void
Parameters
ParameterType
numstring | number
Returns

void

Inherited from

BaseObject.height

Defined in

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


heightOrigin

Get Signature

get heightOrigin(): string | number
Returns

string | number

Inherited from

BaseObject.heightOrigin

Defined in

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


layer

Get Signature

get layer(): Nullable<Layer>
Returns

Nullable<Layer>

Set Signature

set layer(layer): void
Parameters
ParameterType
layerLayer
Returns

void

Inherited from

BaseObject.layer

Defined in

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


left

Get Signature

get left(): number
Returns

number

Set Signature

set left(num): void
Parameters
ParameterType
numstring | number
Returns

void

Inherited from

BaseObject.left

Defined in

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


leftOrigin

Get Signature

get leftOrigin(): string | number
Returns

string | number

Inherited from

BaseObject.leftOrigin

Defined in

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


maxZIndex

Get Signature

get maxZIndex(): number
Returns

number

Inherited from

BaseObject.maxZIndex

Defined in

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


oKey

Get Signature

get oKey(): string
Returns

string

Inherited from

BaseObject.oKey

Defined in

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


parent

Get Signature

get parent(): any
Returns

any

Set Signature

set parent(o): void
Parameters
ParameterType
oany
Returns

void

Inherited from

BaseObject.parent

Defined in

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


printable

Get Signature

get printable(): boolean
Returns

boolean

Inherited from

BaseObject.printable

Defined in

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


scaleX

Get Signature

get scaleX(): number
Returns

number

Set Signature

set scaleX(scaleX): void
Parameters
ParameterType
scaleXnumber
Returns

void

Inherited from

BaseObject.scaleX

Defined in

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


scaleY

Get Signature

get scaleY(): number
Returns

number

Set Signature

set scaleY(scaleY): void
Parameters
ParameterType
scaleYnumber
Returns

void

Inherited from

BaseObject.scaleY

Defined in

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


skewX

Get Signature

get skewX(): number
Returns

number

Set Signature

set skewX(skewX): void
Parameters
ParameterType
skewXnumber
Returns

void

Inherited from

BaseObject.skewX

Defined in

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


skewY

Get Signature

get skewY(): number
Returns

number

Set Signature

set skewY(skewY): void
Parameters
ParameterType
skewYnumber
Returns

void

Inherited from

BaseObject.skewY

Defined in

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


strokeWidth

Get Signature

get strokeWidth(): number
Returns

number

Set Signature

set strokeWidth(width): void
Parameters
ParameterType
widthnumber
Returns

void

Inherited from

BaseObject.strokeWidth

Defined in

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


top

Get Signature

get top(): number
Returns

number

Set Signature

set top(num): void
Parameters
ParameterType
numstring | number
Returns

void

Inherited from

BaseObject.top

Defined in

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


topOrigin

Get Signature

get topOrigin(): string | number
Returns

string | number

Inherited from

BaseObject.topOrigin

Defined in

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


transform

Get Signature

get transform(): Transform
Returns

Transform

Set Signature

set transform(trans): void
Parameters
ParameterType
transTransform
Returns

void

Inherited from

BaseObject.transform

Defined in

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


transformerConfig

Get Signature

get transformerConfig(): ITransformerConfig
Returns

ITransformerConfig

Set Signature

set transformerConfig(config): void
Parameters
ParameterType
configITransformerConfig
Returns

void

Inherited from

BaseObject.transformerConfig

Defined in

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


visible

Get Signature

get visible(): boolean
Returns

boolean

Inherited from

BaseObject.visible

Defined in

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


width

Get Signature

get width(): number
Returns

number

Set Signature

set width(num): void
Parameters
ParameterType
numstring | number
Returns

void

Inherited from

BaseObject.width

Defined in

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


widthOrigin

Get Signature

get widthOrigin(): string | number
Returns

string | number

Inherited from

BaseObject.widthOrigin

Defined in

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


zIndex

Get Signature

get zIndex(): number
Returns

number

Set Signature

set zIndex(index): void
Parameters
ParameterType
indexnumber
Returns

void

Inherited from

BaseObject.zIndex

Defined in

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

Methods

_setTransForm()

protected _setTransForm(): void

Returns

void

Inherited from

BaseObject._setTransForm

Defined in

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


applyTransform()

applyTransform(): void

Returns

void

Inherited from

BaseObject.applyTransform

Defined in

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


dispose()

dispose(): void

Returns

void

Inherited from

BaseObject.dispose

Defined in

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


disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

BaseObject.disposeWithMe

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:96


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

BaseObject.ensureNotDisposed

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:100


flip()

flip(flipX?, flipY?): CustomObject

Parameters

ParameterType
flipX?boolean
flipY?boolean

Returns

CustomObject

Inherited from

BaseObject.flip

Defined in

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


getEngine()

getEngine(): Nullable<Engine>

Returns

Nullable<Engine>

Inherited from

BaseObject.getEngine

Defined in

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


getInverseCoord()

getInverseCoord(coord): Vector2

Parameters

ParameterType
coordVector2

Returns

Vector2

Inherited from

BaseObject.getInverseCoord

Defined in

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


getLayerIndex()

getLayerIndex(): number

Returns

number

Inherited from

BaseObject.getLayerIndex

Defined in

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


getObjects()

getObjects(): BaseObject[]

Returns

BaseObject[]

Inherited from

BaseObject.getObjects

Defined in

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


getParent()

getParent(): any

Returns

any

Inherited from

BaseObject.getParent

Defined in

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


getScene()

getScene(): Nullable<Scene>

Returns

Nullable<Scene>

Inherited from

BaseObject.getScene

Defined in

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


getState()

getState(): ITransformState

Returns

ITransformState

Inherited from

BaseObject.getState

Defined in

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


hide()

hide(): void

Returns

void

Inherited from

BaseObject.hide

Defined in

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


isDirty()

isDirty(): boolean

Returns

boolean

Inherited from

BaseObject.isDirty

Defined in

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


isHit()

isHit(coord): boolean

Parameters

ParameterType
coordVector2

Returns

boolean

Overrides

BaseObject.isHit

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/custom/custom-object.ts:66


isRender()

isRender(bounds?): undefined | boolean

Parameters

ParameterType
bounds?IViewportInfo

Returns

undefined | boolean

Inherited from

BaseObject.isRender

Defined in

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


makeDirty()

makeDirty(state): undefined | CustomObject

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

undefined | CustomObject

Inherited from

BaseObject.makeDirty

Defined in

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


makeDirtyNoDebounce()

makeDirtyNoDebounce(state): CustomObject

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

CustomObject

Inherited from

BaseObject.makeDirtyNoDebounce

Defined in

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


makeForceDirty()

makeForceDirty(state): void

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

void

Inherited from

BaseObject.makeForceDirty

Defined in

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


removeTransform()

removeTransform(): void

Returns

void

Inherited from

BaseObject.removeTransform

Defined in

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


render()

render(mainCtx, bounds?): CustomObject

Parameters

ParameterType
mainCtxUniverRenderingContext
bounds?IViewportInfo

Returns

CustomObject

Overrides

BaseObject.render

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/custom/custom-object.ts:36


resetCursor()

resetCursor(): void

Returns

void

Inherited from

BaseObject.resetCursor

Defined in

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


resize()

resize(width?, height?): CustomObject

Parameters

ParameterType
width?string | number
height?string | number

Returns

CustomObject

Inherited from

BaseObject.resize

Defined in

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


scale()

scale(scaleX?, scaleY?): CustomObject

Parameters

ParameterType
scaleX?number
scaleY?number

Returns

CustomObject

Inherited from

BaseObject.scale

Defined in

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


setCursor()

setCursor(val): void

Parameters

ParameterType
valCURSOR_TYPE

Returns

void

Inherited from

BaseObject.setCursor

Defined in

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


show()

show(): void

Returns

void

Inherited from

BaseObject.show

Defined in

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


skew()

skew(skewX?, skewY?): CustomObject

Parameters

ParameterType
skewX?number
skewY?number

Returns

CustomObject

Inherited from

BaseObject.skew

Defined in

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


toJson()

toJson(): {}

Returns

{}

Overrides

BaseObject.toJson

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/custom/custom-object.ts:30


transformByState()

transformByState(option): undefined | CustomObject

this[pKey] = option[pKey]

Parameters

ParameterType
optionIObjectFullState

Returns

undefined | CustomObject

Inherited from

BaseObject.transformByState

Defined in

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


transformForAngle()

transformForAngle(transform): Transform

Parameters

ParameterType
transformTransform

Returns

Transform

Inherited from

BaseObject.transformForAngle

Defined in

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


translate()

translate(x?, y?): CustomObject

Parameters

ParameterType
x?string | number
y?string | number

Returns

CustomObject

Inherited from

BaseObject.translate

Defined in

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


triggerDblclick()

triggerDblclick(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerDblclick

Defined in

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


triggerDragEnter()

triggerDragEnter(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IDragEvent

Returns

boolean

Inherited from

BaseObject.triggerDragEnter

Defined in

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


triggerDragLeave()

triggerDragLeave(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IDragEvent

Returns

boolean

Inherited from

BaseObject.triggerDragLeave

Defined in

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


triggerDragOver()

triggerDragOver(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IDragEvent

Returns

boolean

Inherited from

BaseObject.triggerDragOver

Defined in

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


triggerDrop()

triggerDrop(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IDragEvent

Returns

boolean

Inherited from

BaseObject.triggerDrop

Defined in

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


triggerMouseWheel()

triggerMouseWheel(evt): boolean

Parameters

ParameterType
evtIWheelEvent

Returns

boolean

Inherited from

BaseObject.triggerMouseWheel

Defined in

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


triggerPointerDown()

triggerPointerDown(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerDown

Defined in

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


triggerPointerEnter()

triggerPointerEnter(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerEnter

Defined in

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


triggerPointerLeave()

triggerPointerLeave(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerLeave

Defined in

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


triggerPointerMove()

triggerPointerMove(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerMove

Defined in

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


triggerPointerOut()

triggerPointerOut(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerOut

Defined in

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


triggerPointerOver()

triggerPointerOver(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerOver

Defined in

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


triggerPointerUp()

triggerPointerUp(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerUp

Defined in

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


triggerTripleClick()

triggerTripleClick(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerTripleClick

Defined in

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