@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
Parameter | Type |
---|---|
sceneKey | string |
_parent | Engine | SceneViewer |
state ? | ISceneTransformState |
Returns
Overrides
Properties
Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
---|---|---|---|---|---|---|
_disposed | protected | boolean | false | - | Disposable ._disposed | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:96 |
addObject$ | readonly | Observable <Scene > | undefined | - | - | packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:64 |
afterRender$ | readonly | Observable <Nullable <Canvas >> | undefined | - | - | packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:96 |
beforeRender$ | readonly | Observable <Nullable <Canvas >> | undefined | - | - | packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:94 |
onDblclick$ | public | EventSubject < | IMouseEvent | IPointerEvent > | undefined | - | - | packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:79 |
onDragEnter$ | public | EventSubject <IDragEvent > | undefined | - | - | packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:75 |
onDragLeave$ | public | EventSubject <IDragEvent > | undefined | - | - | packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:77 |
onDragOver$ | public | EventSubject <IDragEvent > | undefined | - | - | packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:76 |
onDrop$ | public | EventSubject <IDragEvent > | undefined | - | - | packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:78 |
onFileLoaded$ | public | EventSubject <string > | undefined | - | - | packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:67 |
onKeyDown$ | public | EventSubject <IKeyboardEvent > | undefined | Deprecated use fromGlobalEvent('keydown') from rx.js instead. | - | packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:86 |
onKeyUp$ | public | EventSubject <IKeyboardEvent > | undefined | Deprecated use fromGlobalEvent('keyup') from rx.js instead. | - | packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:91 |
onMouseWheel$ | public | EventSubject <IWheelEvent > | undefined | - | - | packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:81 |
onPointerCancel$ | public | EventSubject < | IMouseEvent | IPointerEvent > | undefined | - | - | packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:73 |
onPointerDown$ | public | EventSubject < | IMouseEvent | IPointerEvent > | undefined | - | - | packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:68 |
onPointerEnter$ | public | EventSubject < | IMouseEvent | IPointerEvent > | undefined | - | - | packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:71 |
onPointerLeave$ | public | EventSubject < | IMouseEvent | IPointerEvent > | undefined | - | - | packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:74 |
onPointerMove$ | public | EventSubject < | IMouseEvent | IPointerEvent > | undefined | - | - | packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:69 |
onPointerOut$ | public | EventSubject < | IMouseEvent | IPointerEvent > | undefined | - | - | packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:72 |
onPointerUp$ | public | EventSubject < | IMouseEvent | IPointerEvent > | undefined | - | - | packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:70 |
onTransformChange$ | public | EventSubject <ITransformChangeState > | undefined | - | - | packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:66 |
onTripleClick$ | public | EventSubject < | 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
cursor
Set Signature
set cursor(val): void
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:228
Parameters
Parameter | Type |
---|---|
val | CURSOR_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
Parameter | Type |
---|---|
num | number |
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
Parameter | Type |
---|---|
scaleX | number |
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
Parameter | Type |
---|---|
scaleY | number |
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
Set Signature
set transform(trans): void
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:172
Parameters
Parameter | Type |
---|---|
trans | Transform |
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
Parameter | Type |
---|---|
num | number |
Returns
void
Methods
addLayer()
addLayer(...argument): void
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:478
Parameters
Parameter | Type |
---|---|
…argument | Layer [] |
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
Parameter | Type | Default value | Description |
---|---|---|---|
o | BaseObject | undefined | - |
zIndex | number | 1 | layer index |
Returns
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
Parameter | Type | Default value |
---|---|---|
objects | BaseObject [] | undefined |
zIndex | number | 1 |
Returns
this
addViewport()
addViewport(...viewport): Scene
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:663
Parameters
Parameter | Type |
---|---|
…viewport | Viewport [] |
Returns
attachControl()
attachControl(options?): undefined | Scene
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:232
Parameters
Parameter | Type |
---|---|
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
Parameter | Type |
---|---|
o | BaseObject |
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
detachTransformerFrom()
detachTransformerFrom(o): void
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:728
Parameters
Parameter | Type |
---|---|
o | BaseObject |
Returns
void
disableLayerCache()
disableLayerCache(...layerIndexes): void
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:271
Parameters
Parameter | Type |
---|---|
…layerIndexes | number [] |
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
disposeWithMe()
disposeWithMe(disposable): IDisposable
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:99
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
Inherited from
enableLayerCache()
enableLayerCache(...layerIndexes): void
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:265
Parameters
Parameter | Type |
---|---|
…layerIndexes | number [] |
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
findLayerByZIndex()
findLayerByZIndex(zIndex): Nullable<Layer>
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:459
Parameters
Parameter | Type | Default value |
---|---|---|
zIndex | number | 1 |
Returns
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
Parameter | Type |
---|---|
coord | Vector2 |
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
Parameter | Type | Default value |
---|---|---|
oKey | string | undefined |
matchStart | boolean | false |
Returns
getActiveViewportByCoord()
getActiveViewportByCoord(coord): undefined | Viewport
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:765
Parameters
Parameter | Type |
---|---|
coord | Vector2 |
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
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
Parameter | Type | Default value |
---|---|---|
isDesc | boolean | false |
Returns
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[]
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
Parameter | Type | Default value |
---|---|---|
isDesc | boolean | false |
Returns
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;
}
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
Parameter | Type | Description |
---|---|---|
coord | Vector2 | Coordinates to be converted. |
Returns
getCursor()
getCursor(): CURSOR_TYPE
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:287
Returns
getDefaultViewport()
getDefaultViewport(): Viewport
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:792
Returns
getEngine()
getEngine(): Nullable<Engine>
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:431
Returns
getLayer()
getLayer(zIndex): Layer
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:450
Parameters
Parameter | Type | Default value |
---|---|---|
zIndex | number | 1 |
Returns
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
getObject()
getObject(oKey): Nullable<BaseObject>
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:627
Parameters
Parameter | Type |
---|---|
oKey | string |
Returns
getObjectIncludeInGroup()
getObjectIncludeInGroup(oKey): Nullable<BaseObject>
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:638
Parameters
Parameter | Type |
---|---|
oKey | string |
Returns
getObjectsByLayer()
getObjectsByLayer(zIndex): BaseObject[]
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:560
Parameters
Parameter | Type |
---|---|
zIndex | number |
Returns
getParent()
getParent(): Engine | SceneViewer
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:427
Returns
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;
}
getRelativeToViewportCoord()
getRelativeToViewportCoord(coord): Vector2
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:816
Parameters
Parameter | Type |
---|---|
coord | Vector2 |
Returns
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
Parameter | Type |
---|---|
pos | Vector2 |
viewPort ? | Viewport |
Returns
{
x: number;
y: number;
}
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
Parameter | Type |
---|---|
key | string |
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
Parameter | Type |
---|---|
viewPort | Viewport |
Returns
{
x: number;
y: number;
}
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
Parameter | Type |
---|---|
pos | Vector2 |
viewPort ? | Viewport |
Returns
{
x: number;
y: number;
}
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
Parameter | Type |
---|---|
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
Parameter | Type | Default value |
---|---|---|
state | boolean | true |
Returns
makeDirtyNoParent()
makeDirtyNoParent(state): Scene
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:258
Parameters
Parameter | Type | Default value |
---|---|---|
state | boolean | true |
Returns
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
Parameter | Type |
---|---|
coord | Vector2 |
Returns
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
Parameter | Type |
---|---|
object ? | string | BaseObject |
Returns
removeObjects()
removeObjects(objects?): Nullable<Scene>
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:535
Parameters
Parameter | Type |
---|---|
objects ? | string [] | BaseObject [] |
Returns
removeViewport()
removeViewport(key): undefined | Viewport
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:668
Parameters
Parameter | Type |
---|---|
key | string |
Returns
undefined
| Viewport
render()
render(parentCtx?): void
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:694
Parameters
Parameter | Type |
---|---|
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
Parameter | Type |
---|---|
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
Parameter | Type |
---|---|
width ? | number |
height ? | number |
Returns
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
Parameter | Type |
---|---|
scaleX ? | number |
scaleY ? | number |
Returns
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
Parameter | Type |
---|---|
scaleX ? | number |
scaleY ? | number |
Returns
setCursor()
setCursor(val): void
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:295
Parameters
Parameter | Type |
---|---|
val | CURSOR_TYPE |
Returns
void
setDefaultCursor()
setDefaultCursor(val): void
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:304
Parameters
Parameter | Type |
---|---|
val | CURSOR_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
Parameter | Type |
---|---|
o | BaseObject |
Returns
void
setScaleValue()
setScaleValue(scaleX, scaleY): void
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:333
Parameters
Parameter | Type |
---|---|
scaleX | number |
scaleY | number |
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
Parameter | Type |
---|---|
state | ISceneTransformState |
Returns
void
triggerDblclick()
triggerDblclick(evt): boolean
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1062
Parameters
Parameter | Type |
---|---|
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
Parameter | Type |
---|---|
evt | IDragEvent |
Returns
boolean
triggerDragLeave()
triggerDragLeave(evt): boolean
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1146
Parameters
Parameter | Type |
---|---|
evt | IDragEvent |
Returns
boolean
triggerDragOver()
triggerDragOver(evt): boolean
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1157
Parameters
Parameter | Type |
---|---|
evt | IDragEvent |
Returns
boolean
triggerDrop()
triggerDrop(evt): boolean
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1179
Parameters
Parameter | Type |
---|---|
evt | IDragEvent |
Returns
boolean
triggerMouseWheel()
triggerMouseWheel(evt): boolean
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1040
Parameters
Parameter | Type |
---|---|
evt | IWheelEvent |
Returns
boolean
triggerPointerCancel()
triggerPointerCancel(evt): boolean
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1126
Parameters
Parameter | Type |
---|---|
evt | IPointerEvent |
Returns
boolean
triggerPointerDown()
triggerPointerDown(evt): boolean
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/scene.ts:1084
Parameters
Parameter | Type |
---|---|
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
Parameter | Type |
---|---|
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
Parameter | Type |
---|---|
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
Parameter | Type |
---|---|
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
Parameter | Type |
---|---|
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
Parameter | Type |
---|---|
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
Parameter | Type |
---|---|
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
Parameter | Type |
---|---|
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
Parameter | Type |
---|---|
left | number |
top | number |
Returns
void