@univerjs/engine-render v0.4.2 • Docs

Class: Group

Extends

BaseObject

Constructors

new Group()

new Group(key?, ...objects?): Group

Parameters

Parameter	Type
`key`?	`string`
...`objects`?	`BaseObject`[]

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_dirty`	`protected`	`boolean`	`true`	`BaseObject`.`_dirty`	submodules/univer/packages/engine-render/src/base-object.ts:88 (opens in a new tab)
`_disposed`	`protected`	`boolean`	`false`	`BaseObject`.`_disposed`	submodules/univer/packages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
`_forceDirty`	`protected`	`boolean`	`true`	`BaseObject`.`_forceDirty`	submodules/univer/packages/engine-render/src/base-object.ts:89 (opens in a new tab)
`_oKey`	`protected`	`string`	`undefined`	`BaseObject`.`_oKey`	submodules/univer/packages/engine-render/src/base-object.ts:86 (opens in a new tab)
`groupKey?`	`public`	`string`	`undefined`	`BaseObject`.`groupKey`	submodules/univer/packages/engine-render/src/base-object.ts:59 (opens in a new tab)
`isInGroup`	`public`	`boolean`	`false`	`BaseObject`.`isInGroup`	submodules/univer/packages/engine-render/src/base-object.ts:60 (opens in a new tab)
`objectType`	`public`	`ObjectType`	`ObjectType.UNKNOWN`	`BaseObject`.`objectType`	submodules/univer/packages/engine-render/src/base-object.ts:62 (opens in a new tab)
`onDblclick$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`BaseObject`.`onDblclick$`	submodules/univer/packages/engine-render/src/base-object.ts:74 (opens in a new tab)
`onDispose$`	`public`	`EventSubject`<`BaseObject`>	`undefined`	`BaseObject`.`onDispose$`	submodules/univer/packages/engine-render/src/base-object.ts:84 (opens in a new tab)
`onDragEnter$`	`public`	`EventSubject`<`IMouseEvent` \| `IDragEvent`>	`undefined`	`BaseObject`.`onDragEnter$`	submodules/univer/packages/engine-render/src/base-object.ts:80 (opens in a new tab)
`onDragLeave$`	`public`	`EventSubject`<`IMouseEvent` \| `IDragEvent`>	`undefined`	`BaseObject`.`onDragLeave$`	submodules/univer/packages/engine-render/src/base-object.ts:78 (opens in a new tab)
`onDragOver$`	`public`	`EventSubject`<`IMouseEvent` \| `IDragEvent`>	`undefined`	`BaseObject`.`onDragOver$`	submodules/univer/packages/engine-render/src/base-object.ts:79 (opens in a new tab)
`onDrop$`	`public`	`EventSubject`<`IMouseEvent` \| `IDragEvent`>	`undefined`	`BaseObject`.`onDrop$`	submodules/univer/packages/engine-render/src/base-object.ts:81 (opens in a new tab)
`onIsAddedToParent$`	`public`	`EventSubject`<`any`>	`undefined`	`BaseObject`.`onIsAddedToParent$`	submodules/univer/packages/engine-render/src/base-object.ts:83 (opens in a new tab)
`onMouseWheel$`	`public`	`EventSubject`<`IWheelEvent`>	`undefined`	`BaseObject`.`onMouseWheel$`	submodules/univer/packages/engine-render/src/base-object.ts:76 (opens in a new tab)
`onPointerDown$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`BaseObject`.`onPointerDown$`	submodules/univer/packages/engine-render/src/base-object.ts:66 (opens in a new tab)
`onPointerEnter$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`BaseObject`.`onPointerEnter$`	submodules/univer/packages/engine-render/src/base-object.ts:72 (opens in a new tab)
`onPointerLeave$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`BaseObject`.`onPointerLeave$`	submodules/univer/packages/engine-render/src/base-object.ts:71 (opens in a new tab)
`onPointerMove$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`BaseObject`.`onPointerMove$`	submodules/univer/packages/engine-render/src/base-object.ts:67 (opens in a new tab)
`onPointerOut$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`BaseObject`.`onPointerOut$`	submodules/univer/packages/engine-render/src/base-object.ts:69 (opens in a new tab)
`onPointerOver$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`BaseObject`.`onPointerOver$`	submodules/univer/packages/engine-render/src/base-object.ts:70 (opens in a new tab)
`onPointerUp$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`BaseObject`.`onPointerUp$`	submodules/univer/packages/engine-render/src/base-object.ts:68 (opens in a new tab)
`onTransformChange$`	`public`	`EventSubject`<`ITransformChangeState`>	`undefined`	`BaseObject`.`onTransformChange$`	submodules/univer/packages/engine-render/src/base-object.ts:64 (opens in a new tab)
`onTripleClick$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`BaseObject`.`onTripleClick$`	submodules/univer/packages/engine-render/src/base-object.ts:75 (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:251 (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:235 (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:225 (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:230 (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:239 (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:243 (opens in a new tab)

angle

get angle(): number

set angle(angle): void

Parameters

Parameter	Type
`angle`	`number`

Returns

number

Inherited from

BaseObject.angle

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:213 (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/group.ts:38 (opens in a new tab)

cursor

set cursor(val): void

Parameters

Parameter	Type
`val`	`CURSOR_TYPE`

Overrides

BaseObject.cursor

Defined in

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

debounceParentDirty

get debounceParentDirty(): boolean

set debounceParentDirty(state): void

Parameters

Parameter	Type
`state`	`boolean`

Returns

boolean

Inherited from

BaseObject.debounceParentDirty

Defined in

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

evented

get evented(): boolean

set evented(state): void

Parameters

Parameter	Type
`state`	`boolean`

Returns

boolean

Inherited from

BaseObject.evented

Defined in

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

flipX

get flipX(): boolean

set flipX(flipX): void

Parameters

Parameter	Type
`flipX`	`boolean`

Returns

boolean

Inherited from

BaseObject.flipX

Defined in

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

flipY

get flipY(): boolean

set flipY(flipY): void

Parameters

Parameter	Type
`flipY`	`boolean`

Returns

boolean

Inherited from

BaseObject.flipY

Defined in

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

height

get height(): number

set height(val): void

Parameters

Parameter	Type
`val`	`number`

Returns

number

Overrides

BaseObject.height

Defined in

submodules/univer/packages/engine-render/src/group.ts:76 (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:185 (opens in a new tab)

layer

get layer(): Nullable<Layer>

set layer(layer): void

Parameters

Parameter	Type
`layer`	`Layer`

Returns

Nullable<Layer>

Inherited from

BaseObject.layer

Defined in

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

left

get left(): number

set left(num): void

Parameters

Parameter	Type
`num`	`string` \| `number`

Returns

number

Inherited from

BaseObject.left

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:197 (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:177 (opens in a new tab)

maxZIndex

get maxZIndex(): number

Returns

number

Overrides

BaseObject.maxZIndex

Defined in

submodules/univer/packages/engine-render/src/group.ts:107 (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:283 (opens in a new tab)

parent

get parent(): any

set parent(o): void

Parameters

Parameter	Type
`o`	`any`

Returns

any

Inherited from

BaseObject.parent

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:279 (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:169 (opens in a new tab)

scaleX

get scaleX(): number

set scaleX(scaleX): void

Parameters

Parameter	Type
`scaleX`	`number`

Returns

number

Inherited from

BaseObject.scaleX

Defined in

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

scaleY

get scaleY(): number

set scaleY(scaleY): void

Parameters

Parameter	Type
`scaleY`	`number`

Returns

number

Inherited from

BaseObject.scaleY

Defined in

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

skewX

get skewX(): number

set skewX(skewX): void

Parameters

Parameter	Type
`skewX`	`number`

Returns

number

Inherited from

BaseObject.skewX

Defined in

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

skewY

get skewY(): number

set skewY(skewY): void

Parameters

Parameter	Type
`skewY`	`number`

Returns

number

Inherited from

BaseObject.skewY

Defined in

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

strokeWidth

get strokeWidth(): number

set strokeWidth(width): void

Parameters

Parameter	Type
`width`	`number`

Returns

number

Inherited from

BaseObject.strokeWidth

Defined in

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

top

get top(): number

set top(num): void

Parameters

Parameter	Type
`num`	`string` \| `number`

Returns

number

Inherited from

BaseObject.top

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:193 (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:173 (opens in a new tab)

transform

get transform(): Transform

set transform(trans): void

Parameters

Parameter	Type
`trans`	`Transform`

Returns

Transform

Inherited from

BaseObject.transform

Defined in

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

transformerConfig

get transformerConfig(): ITransformerConfig

set transformerConfig(config): void

Parameters

Parameter	Type
`config`	`ITransformerConfig`

Returns

ITransformerConfig

Inherited from

BaseObject.transformerConfig

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:391 (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:295 (opens in a new tab)

width

get width(): number

set width(val): void

Parameters

Parameter	Type
`val`	`number`

Returns

number

Overrides

BaseObject.width

Defined in

submodules/univer/packages/engine-render/src/group.ts:69 (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:181 (opens in a new tab)

zIndex

get zIndex(): number

set zIndex(index): void

Parameters

Parameter	Type
`index`	`number`

Returns

number

Inherited from

BaseObject.zIndex

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:287 (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:858 (opens in a new tab)

addObject()

addObject(o): void

Parameters

Parameter	Type
`o`	`string` \| `BaseObject`

Returns

void

Defined in

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

addObjects()

addObjects(...objects): void

Parameters

Parameter	Type
...`objects`	`BaseObject`[]

Returns

void

Defined in

submodules/univer/packages/engine-render/src/group.ts:142 (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:846 (opens in a new tab)

closeSelfSizeMode()

closeSelfSizeMode(): void

Returns

void

Defined in

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

dispose()

dispose(): void

Returns

void

Overrides

BaseObject.dispose

Defined in

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

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

BaseObject.disposeWithMe

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:96 (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?): Group

Parameters

Parameter	Type
`flipX`?	`boolean`
`flipY`?	`boolean`

Returns

Group

Overrides

BaseObject.flip

Defined in

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

getEngine()

getEngine(): Nullable<Engine>

Returns

Nullable<Engine>

Inherited from

BaseObject.getEngine

Defined in

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

getInverseCoord()

getInverseCoord(coord): Vector2

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

Vector2

Inherited from

BaseObject.getInverseCoord

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:854 (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:839 (opens in a new tab)

getObjects()

getObjects(): BaseObject[]

Returns

BaseObject[]

Overrides

BaseObject.getObjects

Defined in

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

getObjectsByOrder()

getObjectsByOrder(): BaseObject[]

Returns

BaseObject[]

Defined in

submodules/univer/packages/engine-render/src/group.ts:234 (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:580 (opens in a new tab)

getScene()

getScene(): Nullable<Scene>

Returns

Nullable<Scene>

Inherited from

BaseObject.getScene

Defined in

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

getState()

getState(): ITransformState | {
  angle: 0;
  height: groupHeight;
  left: number;
  scaleX: 1;
  scaleY: 1;
  top: number;
  width: groupWidth;
}

Returns

ITransformState | { angle: 0; height: groupHeight; left: number; scaleX: 1; scaleY: 1; top: number; width: groupWidth; }

Overrides

BaseObject.getState

Defined in

submodules/univer/packages/engine-render/src/group.ts:46 (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:600 (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:431 (opens in a new tab)

isHit()

isHit(coord): boolean

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

boolean

Overrides

BaseObject.isHit

Defined in

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

isRender()

isRender(bounds?): undefined | boolean

Parameters

Parameter	Type
`bounds`?	`IViewportInfo`

Returns

undefined | boolean

Inherited from

BaseObject.isRender

Defined in

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

makeDirty()

makeDirty(state): undefined | Group

Parameters

Parameter	Type	Default value
`state`	`boolean`	`true`

Returns

undefined | Group

Inherited from

BaseObject.makeDirty

Defined in

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

makeDirtyNoDebounce()

makeDirtyNoDebounce(state): Group

Parameters

Parameter	Type	Default value
`state`	`boolean`	`true`

Returns

Group

Inherited from

BaseObject.makeDirtyNoDebounce

Defined in

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

makeForceDirty()

makeForceDirty(state): void

Parameters

Parameter	Type	Default value
`state`	`boolean`	`true`

Returns

void

Inherited from

BaseObject.makeForceDirty

Defined in

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

openSelfSizeMode()

openSelfSizeMode(): void

Returns

void

Defined in

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

reCalculateObjects()

reCalculateObjects(): void

Returns

void

Defined in

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

removeObject()

removeObject(object): void

Parameters

Parameter	Type
`object`	`string` \| `BaseObject`

Returns

void

Defined in

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

removeSelfObjectAndTransform()

removeSelfObjectAndTransform(
   oKey, 
   width?, 
   height?, 
   isTransform?): void

Parameters

Parameter	Type	Default value
`oKey`	`string`	`undefined`
`width`?	`number`	`undefined`
`height`?	`number`	`undefined`
`isTransform`?	`boolean`	`false`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/group.ts:195 (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:850 (opens in a new tab)

render()

render(ctx, bounds): void

Parameters

Parameter	Type
`ctx`	`UniverRenderingContext`
`bounds`	`IViewportInfo`

Returns

void

Overrides

BaseObject.render

Defined in

submodules/univer/packages/engine-render/src/group.ts:249 (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:815 (opens in a new tab)

resize()

resize(width?, height?): Group

Parameters

Parameter	Type
`width`?	`string` \| `number`
`height`?	`string` \| `number`

Returns

Group

Overrides

BaseObject.resize

Defined in

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

scale()

scale(scaleX?, scaleY?): Group

Parameters

Parameter	Type
`scaleX`?	`number`
`scaleY`?	`number`

Returns

Group

Overrides

BaseObject.scale

Defined in

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

setCursor()

setCursor(val): void

Parameters

Parameter	Type
`val`	`CURSOR_TYPE`

Returns

void

Inherited from

BaseObject.setCursor

Defined in

submodules/univer/packages/engine-render/src/base-object.ts:819 (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:605 (opens in a new tab)

skew()

skew(skewX?, skewY?): Group

Parameters

Parameter	Type
`skewX`?	`number`
`skewY`?	`number`

Returns

Group

Overrides

BaseObject.skew

Defined in

submodules/univer/packages/engine-render/src/group.ts:271 (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:785 (opens in a new tab)

transformByState()

transformByState(option): undefined | Group

this[pKey] = option[pKey]

Parameters

Parameter	Type
`option`	`IObjectFullState`

Returns

undefined | Group

Inherited from

BaseObject.transformByState

Defined in

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

transformForAngle()

transformForAngle(transform): Transform

Parameters

Parameter	Type
`transform`	`Transform`

Returns

Transform

Inherited from

BaseObject.transformForAngle

Defined in

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

translate()

translate(x?, y?): Group

Parameters

Parameter	Type
`x`?	`string` \| `number`
`y`?	`string` \| `number`

Returns

Group

Inherited from

BaseObject.translate

Defined in

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

triggerDblclick()

triggerDblclick(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

BaseObject.triggerDblclick

Defined in

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

triggerDragEnter()

triggerDragEnter(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IDragEvent`

Returns

boolean

Inherited from

BaseObject.triggerDragEnter

Defined in

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

triggerDragLeave()

triggerDragLeave(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IDragEvent`

Returns

boolean

Inherited from

BaseObject.triggerDragLeave

Defined in

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

triggerDragOver()

triggerDragOver(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IDragEvent`

Returns

boolean

Inherited from

BaseObject.triggerDragOver

Defined in

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

triggerDrop()

triggerDrop(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IDragEvent`

Returns

boolean

Inherited from

BaseObject.triggerDrop

Defined in

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

triggerMouseWheel()

triggerMouseWheel(evt): boolean

Parameters

Parameter	Type
`evt`	`IWheelEvent`

Returns

boolean

Inherited from

BaseObject.triggerMouseWheel

Defined in

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

triggerPointerDown()

triggerPointerDown(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

BaseObject.triggerPointerDown

Defined in

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

triggerPointerEnter()

triggerPointerEnter(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

BaseObject.triggerPointerEnter

Defined in

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

triggerPointerLeave()

triggerPointerLeave(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

BaseObject.triggerPointerLeave

Defined in

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

triggerPointerMove()

triggerPointerMove(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

BaseObject.triggerPointerMove

Defined in

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

triggerPointerOut()

triggerPointerOut(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

BaseObject.triggerPointerOut

Defined in

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

triggerPointerOver()

triggerPointerOver(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

BaseObject.triggerPointerOver

Defined in

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

triggerPointerUp()

triggerPointerUp(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

BaseObject.triggerPointerUp

Defined in

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

triggerTripleClick()

triggerTripleClick(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

BaseObject.triggerTripleClick

Defined in

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

Fontcache Hitcanvas