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

@univerjs/engine-render v0.1.17Docs


Class: Scene

Extends

  • ThinScene

Constructors

new Scene()

new Scene(
   sceneKey, 
   _parent, 
   state?): Scene

Parameters

ParameterType
sceneKeystring
_parentSceneViewer | ThinEngine<Scene>
state?ISceneTransformState

Returns

Scene

Overrides

ThinScene.constructor

Defined in

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

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseThinScene._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
addObject$readonlyObservable<Scene>undefined-submodules/univer/packages/engine-render/src/scene.ts:49 (opens in a new tab)
debounceParentTimeoutpublicnumber-1ThinScene.debounceParentTimeoutsubmodules/univer/packages/engine-render/src/thin-scene.ts:64 (opens in a new tab)
onDblclick$publicEventSubject<IMouseEvent | IPointerEvent>undefinedThinScene.onDblclick$submodules/univer/packages/engine-render/src/thin-scene.ts:54 (opens in a new tab)
onDragEnter$publicEventSubject<IDragEvent>undefinedThinScene.onDragEnter$submodules/univer/packages/engine-render/src/thin-scene.ts:46 (opens in a new tab)
onDragLeave$publicEventSubject<IDragEvent>undefinedThinScene.onDragLeave$submodules/univer/packages/engine-render/src/thin-scene.ts:50 (opens in a new tab)
onDragOver$publicEventSubject<IDragEvent>undefinedThinScene.onDragOver$submodules/univer/packages/engine-render/src/thin-scene.ts:48 (opens in a new tab)
onDrop$publicEventSubject<IDragEvent>undefinedThinScene.onDrop$submodules/univer/packages/engine-render/src/thin-scene.ts:52 (opens in a new tab)
onFileLoaded$publicEventSubject<string>undefinedThinScene.onFileLoaded$submodules/univer/packages/engine-render/src/thin-scene.ts:34 (opens in a new tab)
onKeyDown$publicEventSubject<IKeyboardEvent>undefinedThinScene.onKeyDown$submodules/univer/packages/engine-render/src/thin-scene.ts:60 (opens in a new tab)
onKeyUp$publicEventSubject<IKeyboardEvent>undefinedThinScene.onKeyUp$submodules/univer/packages/engine-render/src/thin-scene.ts:62 (opens in a new tab)
onMouseWheel$publicEventSubject<IWheelEvent>undefinedThinScene.onMouseWheel$submodules/univer/packages/engine-render/src/thin-scene.ts:58 (opens in a new tab)
onPointerDown$publicEventSubject<IMouseEvent | IPointerEvent>undefinedThinScene.onPointerDown$submodules/univer/packages/engine-render/src/thin-scene.ts:36 (opens in a new tab)
onPointerEnter$publicEventSubject<IMouseEvent | IPointerEvent>undefinedThinScene.onPointerEnter$submodules/univer/packages/engine-render/src/thin-scene.ts:42 (opens in a new tab)
onPointerLeave$publicEventSubject<IMouseEvent | IPointerEvent>undefinedThinScene.onPointerLeave$submodules/univer/packages/engine-render/src/thin-scene.ts:44 (opens in a new tab)
onPointerMove$publicEventSubject<IMouseEvent | IPointerEvent>undefinedThinScene.onPointerMove$submodules/univer/packages/engine-render/src/thin-scene.ts:38 (opens in a new tab)
onPointerUp$publicEventSubject<IMouseEvent | IPointerEvent>undefinedThinScene.onPointerUp$submodules/univer/packages/engine-render/src/thin-scene.ts:40 (opens in a new tab)
onTransformChange$publicEventSubject<ITransformChangeState>undefinedThinScene.onTransformChange$submodules/univer/packages/engine-render/src/thin-scene.ts:32 (opens in a new tab)
onTripleClick$publicEventSubject<IMouseEvent | IPointerEvent>undefinedThinScene.onTripleClick$submodules/univer/packages/engine-render/src/thin-scene.ts:56 (opens in a new tab)

Accessors

ancestorLeft

get ancestorLeft(): number

Returns

number

Defined in

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


ancestorScaleX

get ancestorScaleX(): number

Returns

number

Defined in

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


ancestorScaleY

get ancestorScaleY(): number

Returns

number

Defined in

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


ancestorTop

get ancestorTop(): number

Returns

number

Defined in

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


classType

get classType(): RENDER_CLASS_TYPE

Returns

RENDER_CLASS_TYPE

Inherited from

ThinScene.classType

Defined in

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


cursor

set cursor(val): void

Parameters

ParameterType
valCURSOR_TYPE

Defined in

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


evented

get evented(): boolean

Returns

boolean

Inherited from

ThinScene.evented

Defined in

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


height

get height(): number
set height(num): void

Parameters

ParameterType
numnumber

Returns

number

Inherited from

ThinScene.height

Defined in

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


scaleX

get scaleX(): number
set scaleX(scaleX): void

Parameters

ParameterType
scaleXnumber

Returns

number

Inherited from

ThinScene.scaleX

Defined in

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


scaleY

get scaleY(): number
set scaleY(scaleY): void

Parameters

ParameterType
scaleYnumber

Returns

number

Inherited from

ThinScene.scaleY

Defined in

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


sceneKey

get sceneKey(): string

Returns

string

Inherited from

ThinScene.sceneKey

Defined in

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


transform

get transform(): Transform
set transform(trans): void

Parameters

ParameterType
transTransform

Returns

Transform

Inherited from

ThinScene.transform

Defined in

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


width

get width(): number
set width(num): void

Parameters

ParameterType
numnumber

Returns

number

Inherited from

ThinScene.width

Defined in

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

Methods

addLayer()

addLayer(...argument): void

Parameters

ParameterType
...argumentLayer[]

Returns

void

Defined in

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


addObject()

addObject(o, zIndex): Scene

Parameters

ParameterTypeDefault value
oBaseObjectundefined
zIndexnumber1

Returns

Scene

Overrides

ThinScene.addObject

Defined in

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


addObjects()

addObjects(objects, zIndex): Scene

Parameters

ParameterTypeDefault value
objectsBaseObject[]undefined
zIndexnumber1

Returns

Scene

Overrides

ThinScene.addObjects

Defined in

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


addViewport()

addViewport(...viewport): Scene

Parameters

ParameterType
...viewportViewport[]

Returns

Scene

Overrides

ThinScene.addViewport

Defined in

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


attachControl()

attachControl(
   hasDown, 
   hasUp, 
   hasMove, 
   hasWheel): undefined | Scene

Parameters

ParameterTypeDefault value
hasDownbooleantrue
hasUpbooleantrue
hasMovebooleantrue
hasWheelbooleantrue

Returns

undefined | Scene

Defined in

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


attachTransformerTo()

attachTransformerTo(o): void

Parameters

ParameterType
oBaseObject

Returns

void

Overrides

ThinScene.attachTransformerTo

Defined in

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


clearLayer()

clearLayer(): void

Returns

void

Defined in

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


clearViewports()

clearViewports(): void

Returns

void

Defined in

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


detachControl()

detachControl(): Scene

Returns

Scene

Defined in

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


detachTransformerFrom()

detachTransformerFrom(o): void

Parameters

ParameterType
oBaseObject

Returns

void

Overrides

ThinScene.detachTransformerFrom

Defined in

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


disableEvent()

disableEvent(): void

Returns

void

Inherited from

ThinScene.disableEvent

Defined in

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


disableLayerCache()

disableLayerCache(...layerIndexes): void

Parameters

ParameterType
...layerIndexesnumber[]

Returns

void

Defined in

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


dispose()

dispose(): void

Returns

void

Overrides

ThinScene.dispose

Defined in

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


disposeWithMe()

protected disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

ThinScene.disposeWithMe

Defined in

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


enableEvent()

enableEvent(): void

Returns

void

Inherited from

ThinScene.enableEvent

Defined in

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


enableLayerCache()

enableLayerCache(...layerIndexes): void

Parameters

ParameterType
...layerIndexesnumber[]

Returns

void

Defined in

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


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

ThinScene.ensureNotDisposed

Defined in

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


fuzzyMathObjects()

fuzzyMathObjects(oKey): BaseObject[]

Parameters

ParameterType
oKeystring

Returns

BaseObject[]

Defined in

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


getActiveViewportByCoord()

getActiveViewportByCoord(coord): undefined | Viewport

Parameters

ParameterType
coordVector2

Returns

undefined | Viewport

Defined in

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


getActiveViewportByRelativeCoord()

getActiveViewportByRelativeCoord(coord): undefined | Viewport

Parameters

ParameterType
coordVector2

Returns

undefined | Viewport

Defined in

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


getAllObjects()

getAllObjects(): BaseObject[]

Returns

BaseObject[]

Defined in

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


getAllObjectsByOrder()

getAllObjectsByOrder(isDesc): BaseObject[]

Parameters

ParameterTypeDefault value
isDescbooleanfalse

Returns

BaseObject[]

Defined in

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


getAllObjectsByOrderForPick()

getAllObjectsByOrderForPick(isDesc): BaseObject[]

Parameters

ParameterTypeDefault value
isDescbooleanfalse

Returns

BaseObject[]

Defined in

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


getAncestorScale()

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

Returns

{
  scaleX: number;
  scaleY: number;
}
NameTypeDefined in
scaleXnumbersubmodules/univer/packages/engine-render/src/scene.ts:681 (opens in a new tab)
scaleYnumbersubmodules/univer/packages/engine-render/src/scene.ts:682 (opens in a new tab)

Overrides

ThinScene.getAncestorScale

Defined in

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


getCursor()

getCursor(): CURSOR_TYPE

Returns

CURSOR_TYPE

Defined in

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


getEngine()

getEngine(): Nullable<ThinEngine<Scene>>

Returns

Nullable<ThinEngine<Scene>>

Overrides

ThinScene.getEngine

Defined in

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


getLayer()

getLayer(zIndex): Layer

Parameters

ParameterTypeDefault value
zIndexnumber1

Returns

Layer

Defined in

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


getLayerMaxZIndex()

getLayerMaxZIndex(): number

Returns

number

Defined in

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


getLayers()

getLayers(): Layer[]

Returns

Layer[]

Defined in

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


getObject()

getObject(oKey): undefined | BaseObject

Parameters

ParameterType
oKeystring

Returns

undefined | BaseObject

Overrides

ThinScene.getObject

Defined in

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


getObjectIncludeInGroup()

getObjectIncludeInGroup(oKey): undefined | BaseObject

Parameters

ParameterType
oKeystring

Returns

undefined | BaseObject

Defined in

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


getParent()

getParent(): SceneViewer | ThinEngine<Scene>

Returns

SceneViewer | ThinEngine<Scene>

Overrides

ThinScene.getParent

Defined in

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


getPrecisionScale()

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

Returns

{
  scaleX: number;
  scaleY: number;
}
NameTypeDefined in
scaleXnumbersubmodules/univer/packages/engine-render/src/scene.ts:691 (opens in a new tab)
scaleYnumbersubmodules/univer/packages/engine-render/src/scene.ts:692 (opens in a new tab)

Overrides

ThinScene.getPrecisionScale

Defined in

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


getRelativeCoord()

getRelativeCoord(coord): Vector2

In a nested scene scenario, it is necessary to obtain the relative offsets layer by layer.

Parameters

ParameterTypeDescription
coordVector2Coordinates to be converted.

Returns

Vector2

Defined in

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


getScrollXY()

getScrollXY(viewPort): {
  x: number;
  y: number;
}

Parameters

ParameterType
viewPortViewport

Returns

{
  x: number;
  y: number;
}
NameTypeDefined in
xnumbersubmodules/univer/packages/engine-render/src/scene.ts:616 (opens in a new tab)
ynumbersubmodules/univer/packages/engine-render/src/scene.ts:617 (opens in a new tab)

Defined in

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


getScrollXYByRelativeCoords()

getScrollXYByRelativeCoords(coord, viewPort?): {
  x: 0;
  y: 0;
}

Parameters

ParameterType
coordVector2
viewPort?Viewport

Returns

{
  x: 0;
  y: 0;
}
NameTypeDefault valueDefined in
xnumber0submodules/univer/packages/engine-render/src/scene.ts:599 (opens in a new tab)
ynumber0submodules/univer/packages/engine-render/src/scene.ts:600 (opens in a new tab)

Defined in

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


getTransformer()

getTransformer(): Nullable<Transformer>

Returns

Nullable<Transformer>

Defined in

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


getTransformerByCreate()

getTransformerByCreate(): Transformer

Returns

Transformer

Defined in

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


getViewport()

getViewport(key): undefined | Viewport

Parameters

ParameterType
keystring

Returns

undefined | Viewport

Defined in

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


getViewports()

getViewports(): Viewport[]

Returns

Viewport[]

Overrides

ThinScene.getViewports

Defined in

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


initTransformer()

initTransformer(config?): void

Parameters

ParameterType
config?ITransformerConfig

Returns

void

Defined in

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


isDirty()

isDirty(): boolean

Returns

boolean

Defined in

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


makeDirty()

makeDirty(state): Scene

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

Scene

Overrides

ThinScene.makeDirty

Defined in

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


makeDirtyNoParent()

makeDirtyNoParent(state): Scene

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

Scene

Overrides

ThinScene.makeDirtyNoParent

Defined in

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


pick()

pick(coord): Nullable<BaseObject | ThinScene | Scene>

Parameters

ParameterType
coordVector2

Returns

Nullable<BaseObject | ThinScene | Scene>

Overrides

ThinScene.pick

Defined in

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


removeObject()

removeObject(object?): undefined | Scene

Parameters

ParameterType
object?string | BaseObject

Returns

undefined | Scene

Defined in

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


removeObjects()

removeObjects(objects?): undefined | Scene

Parameters

ParameterType
objects?string[] | BaseObject[]

Returns

undefined | Scene

Defined in

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


removeViewport()

removeViewport(key): undefined | Viewport

Parameters

ParameterType
keystring

Returns

undefined | Viewport

Overrides

ThinScene.removeViewport

Defined in

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


render()

render(parentCtx?): void

Parameters

ParameterType
parentCtx?UniverRenderingContext

Returns

void

Overrides

ThinScene.render

Defined in

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


requestRender()

requestRender(parentCtx?): Promise<unknown>

Parameters

ParameterType
parentCtx?UniverRenderingContext

Returns

Promise<unknown>

Defined in

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


resetCursor()

resetCursor(): void

Returns

void

Overrides

ThinScene.resetCursor

Defined in

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


resize()

resize(width?, height?): Scene

Parameters

ParameterType
width?number
height?number

Returns

Scene

Defined in

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


scale()

scale(scaleX?, scaleY?): Scene

scale to value, absolute setTransform ---> viewport._updateScrollBarPosByViewportScroll ---> scrollTo

Parameters

ParameterType
scaleX?number
scaleY?number

Returns

Scene

Defined in

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


scaleBy()

scaleBy(scaleX?, scaleY?): Scene

current scale plus offset, relative

Parameters

ParameterType
scaleX?number
scaleY?number

Returns

Scene

Defined in

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


setCursor()

setCursor(val): void

Parameters

ParameterType
valCURSOR_TYPE

Returns

void

Overrides

ThinScene.setCursor

Defined in

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


setDefaultCursor()

setDefaultCursor(val): void

Parameters

ParameterType
valCURSOR_TYPE

Returns

void

Defined in

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


setObjectBehavior()

setObjectBehavior(o): void

Parameters

ParameterType
oBaseObject

Returns

void

Overrides

ThinScene.setObjectBehavior

Defined in

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


setScaleValue()

setScaleValue(scaleX, scaleY): void

Parameters

ParameterType
scaleXnumber
scaleYnumber

Returns

void

Defined in

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


transformByState()

transformByState(state): void

This sequence will initiate a series of updates: scene._setTransForm --> viewport@resetCanvasSizeAndUpdateScrollBar ---> scrollTo ---> limitedScroll ---> onScrollBeforeObserver ---> setScrollInfo scrollInfo needs accurate scene width & height, limitedScroll depends on scene & engine's width & height

Parameters

ParameterType
stateISceneTransformState

Returns

void

Defined in

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


triggerDblclick()

triggerDblclick(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Overrides

ThinScene.triggerDblclick

Defined in

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


triggerDragEnter()

triggerDragEnter(evt): boolean

Parameters

ParameterType
evtIDragEvent

Returns

boolean

Overrides

ThinScene.triggerDragEnter

Defined in

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


triggerDragLeave()

triggerDragLeave(evt): boolean

Parameters

ParameterType
evtIDragEvent

Returns

boolean

Overrides

ThinScene.triggerDragLeave

Defined in

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


triggerDragOver()

triggerDragOver(evt): boolean

Parameters

ParameterType
evtIDragEvent

Returns

boolean

Overrides

ThinScene.triggerDragOver

Defined in

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


triggerDrop()

triggerDrop(evt): boolean

Parameters

ParameterType
evtIDragEvent

Returns

boolean

Overrides

ThinScene.triggerDrop

Defined in

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


triggerKeyDown()

triggerKeyDown(evt): void

Parameters

ParameterType
evtIKeyboardEvent

Returns

void

Overrides

ThinScene.triggerKeyDown

Defined in

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


triggerKeyUp()

triggerKeyUp(evt): void

Parameters

ParameterType
evtIKeyboardEvent

Returns

void

Overrides

ThinScene.triggerKeyUp

Defined in

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


triggerMouseWheel()

triggerMouseWheel(evt): boolean

Parameters

ParameterType
evtIWheelEvent

Returns

boolean

Overrides

ThinScene.triggerMouseWheel

Defined in

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


triggerPointerDown()

triggerPointerDown(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Overrides

ThinScene.triggerPointerDown

Defined in

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


triggerPointerEnter()

triggerPointerEnter(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Overrides

ThinScene.triggerPointerEnter

Defined in

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


triggerPointerLeave()

triggerPointerLeave(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Overrides

ThinScene.triggerPointerLeave

Defined in

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


triggerPointerMove()

triggerPointerMove(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Overrides

ThinScene.triggerPointerMove

Defined in

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


triggerPointerOut()

triggerPointerOut(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Overrides

ThinScene.triggerPointerOut

Defined in

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


triggerPointerOver()

triggerPointerOver(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Overrides

ThinScene.triggerPointerOver

Defined in

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


triggerPointerUp()

triggerPointerUp(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Overrides

ThinScene.triggerPointerUp

Defined in

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


triggerTripleClick()

triggerTripleClick(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Overrides

ThinScene.triggerTripleClick

Defined in

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


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