API Reference
@univerjs
@univerjs/engine-render
classes
Sceneviewer

@univerjs/engine-render v0.1.17Docs


Class: SceneViewer

Extends

Extended by

Constructors

new SceneViewer()

new SceneViewer(key?, props?): SceneViewer

Parameters

ParameterType
key?string
props?IObjectFullState

Returns

SceneViewer

Overrides

BaseObject.constructor

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:33 (opens in a new tab)

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_dirtyprotectedbooleantrueBaseObject._dirtysubmodules/univer/packages/engine-render/src/base-object.ts:74 (opens in a new tab)
_disposedprotectedbooleanfalseBaseObject._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
_forceDirtyprotectedbooleantrueBaseObject._forceDirtysubmodules/univer/packages/engine-render/src/base-object.ts:75 (opens in a new tab)
_oKeyprotectedstringundefinedBaseObject._oKeysubmodules/univer/packages/engine-render/src/base-object.ts:72 (opens in a new tab)
groupKey?publicstringundefinedBaseObject.groupKeysubmodules/univer/packages/engine-render/src/base-object.ts:47 (opens in a new tab)
isInGrouppublicbooleanfalseBaseObject.isInGroupsubmodules/univer/packages/engine-render/src/base-object.ts:48 (opens in a new tab)
onDblclick$publicEventSubject<IMouseEvent | IPointerEvent>undefinedBaseObject.onDblclick$submodules/univer/packages/engine-render/src/base-object.ts:60 (opens in a new tab)
onDispose$publicEventSubject<BaseObject>undefinedBaseObject.onDispose$submodules/univer/packages/engine-render/src/base-object.ts:70 (opens in a new tab)
onDragEnter$publicEventSubject<IMouseEvent | IDragEvent>undefinedBaseObject.onDragEnter$submodules/univer/packages/engine-render/src/base-object.ts:66 (opens in a new tab)
onDragLeave$publicEventSubject<IMouseEvent | IDragEvent>undefinedBaseObject.onDragLeave$submodules/univer/packages/engine-render/src/base-object.ts:64 (opens in a new tab)
onDragOver$publicEventSubject<IMouseEvent | IDragEvent>undefinedBaseObject.onDragOver$submodules/univer/packages/engine-render/src/base-object.ts:65 (opens in a new tab)
onDrop$publicEventSubject<IMouseEvent | IDragEvent>undefinedBaseObject.onDrop$submodules/univer/packages/engine-render/src/base-object.ts:67 (opens in a new tab)
onIsAddedToParent$publicEventSubject<any>undefinedBaseObject.onIsAddedToParent$submodules/univer/packages/engine-render/src/base-object.ts:69 (opens in a new tab)
onMouseWheel$publicEventSubject<IWheelEvent>undefinedBaseObject.onMouseWheel$submodules/univer/packages/engine-render/src/base-object.ts:62 (opens in a new tab)
onPointerDown$publicEventSubject<IMouseEvent | IPointerEvent>undefinedBaseObject.onPointerDown$submodules/univer/packages/engine-render/src/base-object.ts:52 (opens in a new tab)
onPointerEnter$publicEventSubject<IMouseEvent | IPointerEvent>undefinedBaseObject.onPointerEnter$submodules/univer/packages/engine-render/src/base-object.ts:58 (opens in a new tab)
onPointerLeave$publicEventSubject<IMouseEvent | IPointerEvent>undefinedBaseObject.onPointerLeave$submodules/univer/packages/engine-render/src/base-object.ts:57 (opens in a new tab)
onPointerMove$publicEventSubject<IMouseEvent | IPointerEvent>undefinedBaseObject.onPointerMove$submodules/univer/packages/engine-render/src/base-object.ts:53 (opens in a new tab)
onPointerOut$publicEventSubject<IMouseEvent | IPointerEvent>undefinedBaseObject.onPointerOut$submodules/univer/packages/engine-render/src/base-object.ts:55 (opens in a new tab)
onPointerOver$publicEventSubject<IMouseEvent | IPointerEvent>undefinedBaseObject.onPointerOver$submodules/univer/packages/engine-render/src/base-object.ts:56 (opens in a new tab)
onPointerUp$publicEventSubject<IMouseEvent | IPointerEvent>undefinedBaseObject.onPointerUp$submodules/univer/packages/engine-render/src/base-object.ts:54 (opens in a new tab)
onTransformChange$publicEventSubject<ITransformChangeState>undefinedBaseObject.onTransformChange$submodules/univer/packages/engine-render/src/base-object.ts:50 (opens in a new tab)
onTripleClick$publicEventSubject<IMouseEvent | IPointerEvent>undefinedBaseObject.onTripleClick$submodules/univer/packages/engine-render/src/base-object.ts:61 (opens in a new tab)

Accessors

ancestorGroup

get ancestorGroup(): Nullable<BaseObject>

Returns

Nullable<BaseObject>

Inherited from

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

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

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

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

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

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

ParameterType
anglenumber

Returns

number

Inherited from

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

Overrides

BaseObject.classType

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:39 (opens in a new tab)


cursor

get cursor(): CURSOR_TYPE
set cursor(val): void

Parameters

ParameterType
valCURSOR_TYPE

Returns

CURSOR_TYPE

Inherited from

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

ParameterType
stateboolean

Returns

boolean

Inherited from

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

ParameterType
stateboolean

Returns

boolean

Inherited from

BaseObject.evented

Defined in

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


flipX

get flipX(): boolean
set flipX(flipX): void

Parameters

ParameterType
flipXboolean

Returns

boolean

Inherited from

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

ParameterType
flipYboolean

Returns

boolean

Inherited from

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

ParameterType
numstring | number

Returns

number

Inherited from

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

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

ParameterType
layerLayer

Returns

Nullable<Layer>

Inherited from

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

ParameterType
numstring | number

Returns

number

Inherited from

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

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

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

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

ParameterType
oany

Returns

any

Inherited from

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

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

ParameterType
scaleXnumber

Returns

number

Inherited from

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

ParameterType
scaleYnumber

Returns

number

Inherited from

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

ParameterType
skewXnumber

Returns

number

Inherited from

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

ParameterType
skewYnumber

Returns

number

Inherited from

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

ParameterType
widthnumber

Returns

number

Inherited from

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

ParameterType
numstring | number

Returns

number

Inherited from

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

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

ParameterType
transTransform

Returns

Transform

Inherited from

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

ParameterType
configITransformerConfig

Returns

ITransformerConfig

Inherited from

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

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

ParameterType
numstring | number

Returns

number

Inherited from

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

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

ParameterType
indexnumber

Returns

number

Inherited from

BaseObject.zIndex

Defined in

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

Methods

_setTransForm()

protected _setTransForm(): void

Returns

void

Inherited from

BaseObject._setTransForm

Defined in

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


activeSubScene()

activeSubScene(key): void

Parameters

ParameterType
keyNullable<string>

Returns

void

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:104 (opens in a new tab)


addSubScene()

addSubScene(scene): void

Parameters

ParameterType
sceneThinScene

Returns

void

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:89 (opens in a new tab)


allowSelectedClipElement()

allowSelectedClipElement(): boolean

Returns

boolean

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:123 (opens in a new tab)


applyTransform()

applyTransform(): void

Returns

void

Inherited from

BaseObject.applyTransform

Defined in

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


disableSelectedClipElement()

disableSelectedClipElement(): void

Returns

void

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:119 (opens in a new tab)


dispose()

dispose(): void

Returns

void

Overrides

BaseObject.dispose

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:138 (opens in a new tab)


disposeWithMe()

protected disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

BaseObject.disposeWithMe

Defined in

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


enableSelectedClipElement()

enableSelectedClipElement(): void

Returns

void

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:115 (opens in a new tab)


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

BaseObject.ensureNotDisposed

Defined in

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


flip()

flip(flipX?, flipY?): SceneViewer

Parameters

ParameterType
flipX?boolean
flipY?boolean

Returns

SceneViewer

Inherited from

BaseObject.flip

Defined in

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


getActiveSubScene()

getActiveSubScene(): Nullable<ThinScene>

Returns

Nullable<ThinScene>

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:77 (opens in a new tab)


getEngine()

getEngine(): any

Returns

any

Inherited from

BaseObject.getEngine

Defined in

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


getInverseCoord()

getInverseCoord(coord): Vector2

Parameters

ParameterType
coordVector2

Returns

Vector2

Inherited from

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

BaseObject.getLayerIndex

Defined in

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


getObjects()

getObjects(): BaseObject[]

Returns

BaseObject[]

Inherited from

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

BaseObject.getParent

Defined in

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


getScene()

getScene(): any

Returns

any

Inherited from

BaseObject.getScene

Defined in

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


getState()

getState(): ITransformState

Returns

ITransformState

Inherited from

BaseObject.getState

Defined in

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


getSubScene()

getSubScene(sceneKey): undefined | ThinScene

Parameters

ParameterType
sceneKeystring

Returns

undefined | ThinScene

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:81 (opens in a new tab)


getSubScenes()

getSubScenes(): Map<string, ThinScene>

Returns

Map<string, ThinScene>

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:73 (opens in a new tab)


hide()

hide(): void

Returns

void

Inherited from

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

BaseObject.isDirty

Defined in

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


isHit()

isHit(coord): boolean

Parameters

ParameterType
coordVector2

Returns

boolean

Inherited from

BaseObject.isHit

Defined in

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


isRender()

isRender(bounds?): undefined | boolean

Parameters

ParameterType
bounds?IViewportInfo

Returns

undefined | boolean

Inherited from

BaseObject.isRender

Defined in

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


makeDirty()

makeDirty(state): undefined | SceneViewer

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

undefined | SceneViewer

Inherited from

BaseObject.makeDirty

Defined in

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


makeDirtyNoDebounce()

makeDirtyNoDebounce(state): SceneViewer

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

SceneViewer

Inherited from

BaseObject.makeDirtyNoDebounce

Defined in

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


makeForceDirty()

makeForceDirty(state): void

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

void

Inherited from

BaseObject.makeForceDirty

Defined in

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


pick()

pick(coord): Nullable<BaseObject | ThinScene>

Parameters

ParameterType
coordVector2

Returns

Nullable<BaseObject | ThinScene>

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:128 (opens in a new tab)


removeSubScene()

removeSubScene(key): void

Parameters

ParameterType
keystring

Returns

void

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:95 (opens in a new tab)


removeTransform()

removeTransform(): void

Returns

void

Inherited from

BaseObject.removeTransform

Defined in

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


render()

render(mainCtx, bounds?): SceneViewer

Parameters

ParameterType
mainCtxUniverRenderingContext
bounds?IViewportInfo

Returns

SceneViewer

Overrides

BaseObject.render

Defined in

submodules/univer/packages/engine-render/src/scene-viewer.ts:43 (opens in a new tab)


resetCursor()

resetCursor(): void

Returns

void

Inherited from

BaseObject.resetCursor

Defined in

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


resize()

resize(width?, height?): SceneViewer

Parameters

ParameterType
width?string | number
height?string | number

Returns

SceneViewer

Inherited from

BaseObject.resize

Defined in

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


scale()

scale(scaleX?, scaleY?): SceneViewer

Parameters

ParameterType
scaleX?number
scaleY?number

Returns

SceneViewer

Inherited from

BaseObject.scale

Defined in

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


setCursor()

setCursor(val): void

Parameters

ParameterType
valCURSOR_TYPE

Returns

void

Inherited from

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

BaseObject.show

Defined in

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


skew()

skew(skewX?, skewY?): SceneViewer

Parameters

ParameterType
skewX?number
skewY?number

Returns

SceneViewer

Inherited from

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

BaseObject.toJson

Defined in

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


transformByState()

transformByState(option): undefined | SceneViewer

Parameters

ParameterType
optionIObjectFullState

Returns

undefined | SceneViewer

Inherited from

BaseObject.transformByState

Defined in

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


transformForAngle()

transformForAngle(transform): Transform

Parameters

ParameterType
transformTransform

Returns

Transform

Inherited from

BaseObject.transformForAngle

Defined in

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


translate()

translate(x?, y?): SceneViewer

Parameters

ParameterType
x?string | number
y?string | number

Returns

SceneViewer

Inherited from

BaseObject.translate

Defined in

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


triggerDblclick()

triggerDblclick(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerDblclick

Defined in

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


triggerDragEnter()

triggerDragEnter(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IDragEvent

Returns

boolean

Inherited from

BaseObject.triggerDragEnter

Defined in

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


triggerDragLeave()

triggerDragLeave(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IDragEvent

Returns

boolean

Inherited from

BaseObject.triggerDragLeave

Defined in

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


triggerDragOver()

triggerDragOver(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IDragEvent

Returns

boolean

Inherited from

BaseObject.triggerDragOver

Defined in

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


triggerDrop()

triggerDrop(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IDragEvent

Returns

boolean

Inherited from

BaseObject.triggerDrop

Defined in

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


triggerMouseWheel()

triggerMouseWheel(evt): boolean

Parameters

ParameterType
evtIWheelEvent

Returns

boolean

Inherited from

BaseObject.triggerMouseWheel

Defined in

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


triggerPointerDown()

triggerPointerDown(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerDown

Defined in

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


triggerPointerEnter()

triggerPointerEnter(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerEnter

Defined in

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


triggerPointerLeave()

triggerPointerLeave(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerLeave

Defined in

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


triggerPointerMove()

triggerPointerMove(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerMove

Defined in

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


triggerPointerOut()

triggerPointerOut(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerOut

Defined in

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


triggerPointerOver()

triggerPointerOver(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerOver

Defined in

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


triggerPointerUp()

triggerPointerUp(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerPointerUp

Defined in

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


triggerTripleClick()

triggerTripleClick(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

BaseObject.triggerTripleClick

Defined in

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


Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.