@univerjs/engine-render v0.5.0-beta.1 • Docs


Class: abstract BaseObject

Extends

Extended by

Constructors

new BaseObject()

new BaseObject(key?): BaseObject

Parameters

ParameterType
key?string

Returns

BaseObject

Overrides

Disposable.constructor

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:138

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_dirtyprotectedbooleantrue-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:88
_disposedprotectedbooleanfalseDisposable._disposedpackages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:93
_forceDirtyprotectedbooleantrue-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:89
_oKeyprotectedstringundefined-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:86
groupKey?publicstringundefined-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:59
isInGrouppublicbooleanfalse-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:60
objectTypepublicObjectTypeObjectType.UNKNOWN-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:62
onDblclick$publicEventSubject<IMouseEvent | IPointerEvent>undefined-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:74
onDispose$publicEventSubject<BaseObject>undefined-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:84
onDragEnter$publicEventSubject<IMouseEvent | IDragEvent>undefined-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:80
onDragLeave$publicEventSubject<IMouseEvent | IDragEvent>undefined-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:78
onDragOver$publicEventSubject<IMouseEvent | IDragEvent>undefined-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:79
onDrop$publicEventSubject<IMouseEvent | IDragEvent>undefined-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:81
onIsAddedToParent$publicEventSubject<any>undefined-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:83
onMouseWheel$publicEventSubject<IWheelEvent>undefined-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:76
onPointerDown$publicEventSubject<IMouseEvent | IPointerEvent>undefined-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:66
onPointerEnter$publicEventSubject<IMouseEvent | IPointerEvent>undefined-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:72
onPointerLeave$publicEventSubject<IMouseEvent | IPointerEvent>undefined-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:71
onPointerMove$publicEventSubject<IMouseEvent | IPointerEvent>undefined-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:67
onPointerOut$publicEventSubject<IMouseEvent | IPointerEvent>undefined-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:69
onPointerOver$publicEventSubject<IMouseEvent | IPointerEvent>undefined-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:70
onPointerUp$publicEventSubject<IMouseEvent | IPointerEvent>undefined-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:68
onTransformChange$publicEventSubject<ITransformChangeState>undefined-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:64
onTripleClick$publicEventSubject<IMouseEvent | IPointerEvent>undefined-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:75

Accessors

ancestorGroup

Get Signature

get ancestorGroup(): Nullable<BaseObject>
Returns

Nullable<BaseObject>

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:251


ancestorLeft

Get Signature

get ancestorLeft(): any
Returns

any

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:235


ancestorScaleX

Get Signature

get ancestorScaleX(): number
Returns

number

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:225


ancestorScaleY

Get Signature

get ancestorScaleY(): number
Returns

number

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:230


ancestorTop

Get Signature

get ancestorTop(): any
Returns

any

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:239


ancestorTransform

Get Signature

get ancestorTransform(): any
Returns

any

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:243


angle

Get Signature

get angle(): number
Returns

number

Set Signature

set angle(angle): void
Parameters
ParameterType
anglenumber
Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:213


classType

Get Signature

get classType(): RENDER_CLASS_TYPE
Returns

RENDER_CLASS_TYPE

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:189


cursor

Get Signature

get cursor(): CURSOR_TYPE
Returns

CURSOR_TYPE

Set Signature

set cursor(val): void
Parameters
ParameterType
valCURSOR_TYPE
Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:303


debounceParentDirty

Get Signature

get debounceParentDirty(): boolean
Returns

boolean

Set Signature

set debounceParentDirty(state): void
Parameters
ParameterType
stateboolean
Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:299


evented

Get Signature

get evented(): boolean
Returns

boolean

Set Signature

set evented(state): void
Parameters
ParameterType
stateboolean
Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:291


flipX

Get Signature

get flipX(): boolean
Returns

boolean

Set Signature

set flipX(flipX): void
Parameters
ParameterType
flipXboolean
Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:271


flipY

Get Signature

get flipY(): boolean
Returns

boolean

Set Signature

set flipY(flipY): void
Parameters
ParameterType
flipYboolean
Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:275


height

Get Signature

get height(): number
Returns

number

Set Signature

set height(num): void
Parameters
ParameterType
numstring | number
Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:205


heightOrigin

Get Signature

get heightOrigin(): string | number
Returns

string | number

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:185


layer

Get Signature

get layer(): Nullable<Layer>
Returns

Nullable<Layer>

Set Signature

set layer(layer): void
Parameters
ParameterType
layerLayer
Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:307


left

Get Signature

get left(): number
Returns

number

Set Signature

set left(num): void
Parameters
ParameterType
numstring | number
Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:197


leftOrigin

Get Signature

get leftOrigin(): string | number
Returns

string | number

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:177


maxZIndex

Get Signature

get maxZIndex(): number
Returns

number

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:399


oKey

Get Signature

get oKey(): string
Returns

string

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:283


parent

Get Signature

get parent(): any
Returns

any

Set Signature

set parent(o): void
Parameters
ParameterType
oany
Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:279


printable

Get Signature

get printable(): boolean
Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:169


scaleX

Get Signature

get scaleX(): number
Returns

number

Set Signature

set scaleX(scaleX): void
Parameters
ParameterType
scaleXnumber
Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:217


scaleY

Get Signature

get scaleY(): number
Returns

number

Set Signature

set scaleY(scaleY): void
Parameters
ParameterType
scaleYnumber
Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:221


skewX

Get Signature

get skewX(): number
Returns

number

Set Signature

set skewX(skewX): void
Parameters
ParameterType
skewXnumber
Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:263


skewY

Get Signature

get skewY(): number
Returns

number

Set Signature

set skewY(skewY): void
Parameters
ParameterType
skewYnumber
Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:267


strokeWidth

Get Signature

get strokeWidth(): number
Returns

number

Set Signature

set strokeWidth(width): void
Parameters
ParameterType
widthnumber
Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:209


top

Get Signature

get top(): number
Returns

number

Set Signature

set top(num): void
Parameters
ParameterType
numstring | number
Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:193


topOrigin

Get Signature

get topOrigin(): string | number
Returns

string | number

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:173


transform

Get Signature

get transform(): Transform
Returns

Transform

Set Signature

set transform(trans): void
Parameters
ParameterType
transTransform
Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:148


transformerConfig

Get Signature

get transformerConfig(): ITransformerConfig
Returns

ITransformerConfig

Set Signature

set transformerConfig(config): void
Parameters
ParameterType
configITransformerConfig
Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:391


visible

Get Signature

get visible(): boolean
Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:295


width

Get Signature

get width(): number
Returns

number

Set Signature

set width(num): void
Parameters
ParameterType
numstring | number
Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:201


widthOrigin

Get Signature

get widthOrigin(): string | number
Returns

string | number

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:181


zIndex

Get Signature

get zIndex(): number
Returns

number

Set Signature

set zIndex(index): void
Parameters
ParameterType
indexnumber
Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:287

Methods

_setTransForm()

protected _setTransForm(): void

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:851


applyTransform()

applyTransform(): void

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:839


dispose()

dispose(): void

Returns

void

Overrides

Disposable.dispose

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:753


disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:96


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:100


flip()

flip(flipX?, flipY?): BaseObject

Parameters

ParameterType
flipX?boolean
flipY?boolean

Returns

BaseObject

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:522


getEngine()

getEngine(): Nullable<Engine>

Returns

Nullable<Engine>

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:817


getInverseCoord()

getInverseCoord(coord): Vector2

Parameters

ParameterType
coordVector2

Returns

Vector2

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:847


getLayerIndex()

getLayerIndex(): number

Returns

number

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:832


getObjects()

getObjects(): BaseObject[]

Returns

BaseObject[]

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:828


getParent()

getParent(): any

Returns

any

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:580


getScene()

getScene(): Nullable<Scene>

Returns

Nullable<Scene>

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:796


getState()

getState(): ITransformState

Returns

ITransformState

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:584


hide()

hide(): void

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:600


isDirty()

isDirty(): boolean

Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:431


isHit()

isHit(coord): boolean

Parameters

ParameterType
coordVector2

Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:614


isRender()

isRender(bounds?): undefined | boolean

Parameters

ParameterType
bounds?IViewportInfo

Returns

undefined | boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:573


makeDirty()

makeDirty(state): undefined | BaseObject

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

undefined | BaseObject

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:403


makeDirtyNoDebounce()

makeDirtyNoDebounce(state): BaseObject

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

BaseObject

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:422


makeForceDirty()

makeForceDirty(state): void

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:418


removeTransform()

removeTransform(): void

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:843


render()

render(ctx, bounds): void

Parameters

ParameterType
ctxUniverRenderingContext
boundsIViewportInfo

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:610


resetCursor()

resetCursor(): void

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:808


resize()

resize(width?, height?): BaseObject

Parameters

ParameterType
width?string | number
height?string | number

Returns

BaseObject

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:457


scale()

scale(scaleX?, scaleY?): BaseObject

Parameters

ParameterType
scaleX?number
scaleY?number

Returns

BaseObject

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:478


setCursor()

setCursor(val): void

Parameters

ParameterType
valCURSOR_TYPE

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:812


show()

show(): void

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:605


skew()

skew(skewX?, skewY?): BaseObject

Parameters

ParameterType
skewX?number
skewY?number

Returns

BaseObject

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:500


toJson()

toJson(): IKeyValue

Returns

IKeyValue

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:785


transformByState()

transformByState(option): undefined | BaseObject

this[pKey] = option[pKey]

Parameters

ParameterType
optionIObjectFullState

Returns

undefined | BaseObject

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:547


transformForAngle()

transformForAngle(transform): Transform

Parameters

ParameterType
transformTransform

Returns

Transform

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:153


translate()

translate(x?, y?): BaseObject

Parameters

ParameterType
x?string | number
y?string | number

Returns

BaseObject

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:435


triggerDblclick()

triggerDblclick(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:651


triggerDragEnter()

triggerDragEnter(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IDragEvent

Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:737


triggerDragLeave()

triggerDragLeave(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IDragEvent

Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:721


triggerDragOver()

triggerDragOver(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IDragEvent

Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:729


triggerDrop()

triggerDrop(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IDragEvent

Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:745


triggerMouseWheel()

triggerMouseWheel(evt): boolean

Parameters

ParameterType
evtIWheelEvent

Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:671


triggerPointerDown()

triggerPointerDown(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:635


triggerPointerEnter()

triggerPointerEnter(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:713


triggerPointerLeave()

triggerPointerLeave(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:697


triggerPointerMove()

triggerPointerMove(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:627


triggerPointerOut()

triggerPointerOut(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:689


triggerPointerOver()

triggerPointerOver(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:705


triggerPointerUp()

triggerPointerUp(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:643


triggerTripleClick()

triggerTripleClick(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:661