@univerjs/engine-render v0.5.4


Class: Scene

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:48

Extends

Constructors

new Scene()

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

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:108

Parameters

ParameterType
sceneKeystring
_parentEngine | SceneViewer
state?ISceneTransformState

Returns

Scene

Overrides

Disposable.constructor

Properties

PropertyModifierTypeDefault valueDescriptionInherited fromDefined in
_disposedprotectedbooleanfalse-Disposable._disposedpackages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:96
addObject$readonlyObservable<Scene>undefined--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:64
afterRender$readonlyObservable<Nullable<Canvas>>undefined--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:96
beforeRender$readonlyObservable<Nullable<Canvas>>undefined--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:94
onDblclick$publicEventSubject< | IMouseEvent | IPointerEvent>undefined--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:79
onDragEnter$publicEventSubject<IDragEvent>undefined--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:75
onDragLeave$publicEventSubject<IDragEvent>undefined--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:77
onDragOver$publicEventSubject<IDragEvent>undefined--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:76
onDrop$publicEventSubject<IDragEvent>undefined--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:78
onFileLoaded$publicEventSubject<string>undefined--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:67
onKeyDown$publicEventSubject<IKeyboardEvent>undefinedDeprecated use fromGlobalEvent('keydown') from rx.js instead.-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:86
onKeyUp$publicEventSubject<IKeyboardEvent>undefinedDeprecated use fromGlobalEvent('keyup') from rx.js instead.-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:91
onMouseWheel$publicEventSubject<IWheelEvent>undefined--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:81
onPointerCancel$publicEventSubject< | IMouseEvent | IPointerEvent>undefined--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:73
onPointerDown$publicEventSubject< | IMouseEvent | IPointerEvent>undefined--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:68
onPointerEnter$publicEventSubject< | IMouseEvent | IPointerEvent>undefined--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:71
onPointerLeave$publicEventSubject< | IMouseEvent | IPointerEvent>undefined--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:74
onPointerMove$publicEventSubject< | IMouseEvent | IPointerEvent>undefined--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:69
onPointerOut$publicEventSubject< | IMouseEvent | IPointerEvent>undefined--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:72
onPointerUp$publicEventSubject< | IMouseEvent | IPointerEvent>undefined--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:70
onTransformChange$publicEventSubject<ITransformChangeState>undefined--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:66
onTripleClick$publicEventSubject< | IMouseEvent | IPointerEvent>undefined--packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:80

Accessors

ancestorLeft

Get Signature

get ancestorLeft(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:210

Returns

number


ancestorScaleX

Get Signature

get ancestorScaleX(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:192

Returns

number


ancestorScaleY

Get Signature

get ancestorScaleY(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:201

Returns

number


ancestorTop

Get Signature

get ancestorTop(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:219

Returns

number


classType

Get Signature

get classType(): RENDER_CLASS_TYPE

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:140

Returns

RENDER_CLASS_TYPE


cursor

Set Signature

set cursor(val): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:228

Parameters
ParameterType
valCURSOR_TYPE
Returns

void


height

Get Signature

get height(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:152

Returns

number

Set Signature

set height(num): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:180

Parameters
ParameterType
numnumber
Returns

void


objectsEvented

Get Signature

get objectsEvented(): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:168

Returns

boolean


scaleX

Get Signature

get scaleX(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:156

Returns

number

Set Signature

set scaleX(scaleX): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:184

Parameters
ParameterType
scaleXnumber
Returns

void


scaleY

Get Signature

get scaleY(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:160

Returns

number

Set Signature

set scaleY(scaleY): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:188

Parameters
ParameterType
scaleYnumber
Returns

void


sceneKey

Get Signature

get sceneKey(): string

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:164

Returns

string


transform

Get Signature

get transform(): Transform

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:144

Returns

Transform

Set Signature

set transform(trans): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:172

Parameters
ParameterType
transTransform
Returns

void


width

Get Signature

get width(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:148

Returns

number

Set Signature

set width(num): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:176

Parameters
ParameterType
numnumber
Returns

void

Methods

addLayer()

addLayer(...argument): void

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

Parameters

ParameterType
argumentLayer[]

Returns

void


addObject()

addObject(o, zIndex): Scene

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:502

Add object to Layer (Layer is specified by zIndex). If object is a group, insert all its children and group itself to _objects[].

Parameters

ParameterTypeDefault valueDescription
oBaseObjectundefined-
zIndexnumber1layer index

Returns

Scene

scene


addObjects()

addObjects(objects, zIndex): Scene

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:489

Add objects to Layer( Layer is specfied by zIndex) If object is a group, insert all its children and group itself to _objects[].

Parameters

ParameterTypeDefault value
objectsBaseObject[]undefined
zIndexnumber1

Returns

Scene

this


addViewport()

addViewport(...viewport): Scene

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:663

Parameters

ParameterType
viewportViewport[]

Returns

Scene


attachControl()

attachControl(options?): undefined | Scene

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:232

Parameters

ParameterType
options?ISceneInputControlOptions

Returns

undefined | Scene


attachTransformerTo()

attachTransformerTo(o): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:721

create transformer if not exist, and then transformer attach to object that passed in by parameter.

Parameters

ParameterType
oBaseObject

Returns

void


clearLayer()

clearLayer(): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:866

Returns

void


clearViewports()

clearViewports(): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:870

Returns

void


detachControl()

detachControl(): Scene

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:243

Returns

Scene


detachTransformerFrom()

detachTransformerFrom(o): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:728

Parameters

ParameterType
oBaseObject

Returns

void


disableLayerCache()

disableLayerCache(...layerIndexes): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:271

Parameters

ParameterType
layerIndexesnumber[]

Returns

void


disableObjectsEvent()

disableObjectsEvent(): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1214

If scene.event is disabled, scene.pick(cursor Pos) return null. Then only scene itself can response to pointer event, all objects under the scene would not. see sceneInputManager@_onPointerMove

Returns

void


dispose()

dispose(): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:898

Returns

void

Overrides

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

Disposable.disposeWithMe


enableLayerCache()

enableLayerCache(...layerIndexes): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:265

Parameters

ParameterType
layerIndexesnumber[]

Returns

void


enableObjectsEvent()

enableObjectsEvent(): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1218

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

Disposable.ensureNotDisposed


findLayerByZIndex()

findLayerByZIndex(zIndex): Nullable<Layer>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:459

Parameters

ParameterTypeDefault value
zIndexnumber1

Returns

Nullable<Layer>


findViewportByPosToScene()

findViewportByPosToScene(coord): undefined | Viewport

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:761

Get viewport by cursor position. Position is relative to canvas(event offsetXY).

Parameters

ParameterType
coordVector2

Returns

undefined | Viewport


fuzzyMathObjects()

fuzzyMathObjects(oKey, matchStart): BaseObject[]

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:649

Parameters

ParameterTypeDefault value
oKeystringundefined
matchStartbooleanfalse

Returns

BaseObject[]


getActiveViewportByCoord()

getActiveViewportByCoord(coord): undefined | Viewport

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:765

Parameters

ParameterType
coordVector2

Returns

undefined | Viewport


getAllObjects()

getAllObjects(): BaseObject[]

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:575

Get all objects of each Layer.

Returns

BaseObject[]

objects


getAllObjectsByDescOrder()

getAllObjectsByDescOrder(isDesc): BaseObject[]

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:602

get objects which is visible and not in a group.

Parameters

ParameterTypeDefault value
isDescbooleanfalse

Returns

BaseObject[]

BaseObject[]


getAllObjectsByOrder()

getAllObjectsByOrder(): BaseObject[]

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:588

Get objects which is visible and not in a group in each layer.

Returns

BaseObject[]

BaseObject[]


getAllObjectsByOrderForPick()

getAllObjectsByOrderForPick(isDesc): BaseObject[]

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:617

Get visible and evented objects.

Parameters

ParameterTypeDefault value
isDescbooleanfalse

Returns

BaseObject[]

objects


getAncestorScale()

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

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:874

Returns

{
  scaleX: number;
  scaleY: number;
}
NameTypeDefined in
scaleXnumberpackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:883
scaleYnumberpackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:884

getCoordRelativeToViewport()

getCoordRelativeToViewport(coord): Vector2

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:828

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

origin name: getRelativeToViewportCoord

Parameters

ParameterTypeDescription
coordVector2Coordinates to be converted.

Returns

Vector2


getCursor()

getCursor(): CURSOR_TYPE

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:287

Returns

CURSOR_TYPE


getDefaultViewport()

getDefaultViewport(): Viewport

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:792

Returns

Viewport


getEngine()

getEngine(): Nullable<Engine>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:431

Returns

Nullable<Engine>


getLayer()

getLayer(zIndex): Layer

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:450

Parameters

ParameterTypeDefault value
zIndexnumber1

Returns

Layer


getLayerMaxZIndex()

getLayerMaxZIndex(): number

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:467

Returns

number


getLayers()

getLayers(): Layer[]

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:446

Returns

Layer[]


getMainViewport()

getMainViewport(): Viewport

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:682

Returns

Viewport


getObject()

getObject(oKey): Nullable<BaseObject>

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

Parameters

ParameterType
oKeystring

Returns

Nullable<BaseObject>


getObjectIncludeInGroup()

getObjectIncludeInGroup(oKey): Nullable<BaseObject>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:638

Parameters

ParameterType
oKeystring

Returns

Nullable<BaseObject>


getObjectsByLayer()

getObjectsByLayer(zIndex): BaseObject[]

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:560

Parameters

ParameterType
zIndexnumber

Returns

BaseObject[]


getParent()

getParent(): Engine | SceneViewer

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:427

Returns

Engine | SceneViewer


getPrecisionScale()

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

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:888

Returns

{
  scaleX: number;
  scaleY: number;
}
NameTypeDefined in
scaleXnumberpackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:893
scaleYnumberpackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:894

getRelativeToViewportCoord()

getRelativeToViewportCoord(coord): Vector2

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:816

Parameters

ParameterType
coordVector2

Returns

Vector2

Deprecated

use getCoordRelativeToViewport instead


getScrollXYInfoByViewport()

getScrollXYInfoByViewport(pos, viewPort?): {
  x: number;
  y: number;
}

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:785

getViewportScrollXYInfo by viewport under cursor position prev getScrollXYByRelativeCoords

Parameters

ParameterType
posVector2
viewPort?Viewport

Returns

{
  x: number;
  y: number;
}
NameTypeDefined in
xnumberpackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:806
ynumberpackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:807

getTransformer()

getTransformer(): Nullable<Transformer>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:747

Returns

Nullable<Transformer>


getTransformerByCreate()

getTransformerByCreate(): Transformer

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:740

Returns

Transformer


getViewport()

getViewport(key): undefined | Viewport

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:686

Parameters

ParameterType
keystring

Returns

undefined | Viewport


getViewports()

getViewports(): Viewport[]

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:678

Returns

Viewport[]


getViewportScrollXY()

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

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:796

Parameters

ParameterType
viewPortViewport

Returns

{
  x: number;
  y: number;
}
NameTypeDefined in
xnumberpackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:806
ynumberpackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:807

getVpScrollXYInfoByPosToVp()

getVpScrollXYInfoByPosToVp(pos, viewPort?): {
  x: number;
  y: number;
}

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:775

Parameters

ParameterType
posVector2
viewPort?Viewport

Returns

{
  x: number;
  y: number;
}
NameTypeDefined in
xnumberpackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:806
ynumberpackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:807

Deprecated

use getScrollXYInfoByViewport instead.


initTransformer()

initTransformer(config?): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:732

Parameters

ParameterType
config?ITransformerConfig

Returns

void


isDirty()

isDirty(): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:277

Returns

boolean


makeDirty()

makeDirty(state): Scene

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:248

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

Scene


makeDirtyNoParent()

makeDirtyNoParent(state): Scene

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:258

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

Scene


pick()

pick(coord): Nullable<BaseObject | Scene>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:950

Get the object under the pointer, if scene.event is disabled, the object is null.

Parameters

ParameterType
coordVector2

Returns

Nullable<BaseObject | Scene>

object under the pointer


removeObject()

removeObject(object?): Nullable<Scene>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:524

Parameters

ParameterType
object?string | BaseObject

Returns

Nullable<Scene>


removeObjects()

removeObjects(objects?): Nullable<Scene>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:535

Parameters

ParameterType
objects?string[] | BaseObject[]

Returns

Nullable<Scene>


removeViewport()

removeViewport(key): undefined | Viewport

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:668

Parameters

ParameterType
keystring

Returns

undefined | Viewport


render()

render(parentCtx?): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:694

Parameters

ParameterType
parentCtx?UniverRenderingContext

Returns

void


requestRender()

requestRender(parentCtx?): Promise<unknown>

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:710

Parameters

ParameterType
parentCtx?UniverRenderingContext

Returns

Promise<unknown>


resetCursor()

resetCursor(): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:291

Returns

void


resize()

resize(width?, height?): Scene

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:309

Parameters

ParameterType
width?number
height?number

Returns

Scene


scale()

scale(scaleX?, scaleY?): Scene

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:349

Set scale, and then emit event to update Viewport scroll state.

Parameters

ParameterType
scaleX?number
scaleY?number

Returns

Scene

Scene


scaleBy()

scaleBy(scaleX?, scaleY?): Scene

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:375

current scale plus offset, relative

Parameters

ParameterType
scaleX?number
scaleY?number

Returns

Scene


setCursor()

setCursor(val): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:295

Parameters

ParameterType
valCURSOR_TYPE

Returns

void


setDefaultCursor()

setDefaultCursor(val): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:304

Parameters

ParameterType
valCURSOR_TYPE

Returns

void


setObjectBehavior()

setObjectBehavior(o): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:513

Set Scene as object parent, if object has no parent.

Parameters

ParameterType
oBaseObject

Returns

void


setScaleValue()

setScaleValue(scaleX, scaleY): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:333

Parameters

ParameterType
scaleXnumber
scaleYnumber

Returns

void


transformByState()

transformByState(state): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:404

Reset canvas size and update scroll

Parameters

ParameterType
stateISceneTransformState

Returns

void


triggerDblclick()

triggerDblclick(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1062

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean


triggerDragEnter()

triggerDragEnter(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1168

Parameters

ParameterType
evtIDragEvent

Returns

boolean


triggerDragLeave()

triggerDragLeave(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1146

Parameters

ParameterType
evtIDragEvent

Returns

boolean


triggerDragOver()

triggerDragOver(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1157

Parameters

ParameterType
evtIDragEvent

Returns

boolean


triggerDrop()

triggerDrop(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1179

Parameters

ParameterType
evtIDragEvent

Returns

boolean


triggerMouseWheel()

triggerMouseWheel(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1040

Parameters

ParameterType
evtIWheelEvent

Returns

boolean


triggerPointerCancel()

triggerPointerCancel(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1126

Parameters

ParameterType
evtIPointerEvent

Returns

boolean


triggerPointerDown()

triggerPointerDown(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1084

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean


triggerPointerEnter()

triggerPointerEnter(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1134

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean


triggerPointerLeave()

triggerPointerLeave(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1105

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean


triggerPointerMove()

triggerPointerMove(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1051

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean


triggerPointerOut()

triggerPointerOut(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1096

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean


triggerPointerOver()

triggerPointerOver(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1117

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean


triggerPointerUp()

triggerPointerUp(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1029

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean


triggerTripleClick()

triggerTripleClick(evt): boolean

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1073

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean


updateTransformerZero()

updateTransformerZero(left, top): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:751

Parameters

ParameterType
leftnumber
topnumber

Returns

void