@univerjs/engine-render v0.4.2 • Docs
Class: RenderComponent<T, U, V>
Extends
Extended by
Type Parameters
Type Parameter |
---|
T |
U |
V |
Constructors
new RenderComponent()
new RenderComponent<T, U, V>(key?): RenderComponent<T, U, V>
Parameters
Parameter | Type |
---|---|
key ? | string |
Returns
RenderComponent
<T
, U
, V
>
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:138 (opens in a new tab)
Properties
Accessors
ancestorGroup
get ancestorGroup(): Nullable<BaseObject>
Returns
Inherited from
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
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
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
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
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
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
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:213 (opens in a new tab)
classType
get classType(): RENDER_CLASS_TYPE
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:189 (opens in a new tab)
cursor
get cursor(): CURSOR_TYPE
set cursor(val): void
Parameters
Parameter | Type |
---|---|
val | CURSOR_TYPE |
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:303 (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
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:291 (opens in a new tab)
extensions
get extensions(): Map<string, ComponentExtension<T, U, V>>
Returns
Map
<string
, ComponentExtension
<T
, U
, V
>>
Defined in
submodules/univer/packages/engine-render/src/components/component.ts:27 (opens in a new tab)
flipX
get flipX(): boolean
set flipX(flipX): void
Parameters
Parameter | Type |
---|---|
flipX | boolean |
Returns
boolean
Inherited from
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
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:275 (opens in a new tab)
height
get height(): number
set height(num): void
Parameters
Parameter | Type |
---|---|
num | string | number |
Returns
number
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:205 (opens in a new tab)
heightOrigin
get heightOrigin(): string | number
Returns
string
| number
Inherited from
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
Inherited from
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
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
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:177 (opens in a new tab)
maxZIndex
get maxZIndex(): number
Returns
number
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:399 (opens in a new tab)
oKey
get oKey(): string
Returns
string
Inherited from
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
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
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
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
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
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
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
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
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
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
Inherited from
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
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
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:295 (opens in a new tab)
width
get width(): number
set width(num): void
Parameters
Parameter | Type |
---|---|
num | string | number |
Returns
number
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:201 (opens in a new tab)
widthOrigin
get widthOrigin(): string | number
Returns
string
| number
Inherited from
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
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
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:858 (opens in a new tab)
applyTransform()
applyTransform(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:846 (opens in a new tab)
dispose()
dispose(): void
Returns
void
Overrides
Defined in
submodules/univer/packages/engine-render/src/components/component.ts:65 (opens in a new tab)
disposeWithMe()
disposeWithMe(disposable): IDisposable
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
Inherited from
Defined in
submodules/univer/packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)
draw()
draw(ctx, bounds?): void
Parameters
Parameter | Type |
---|---|
ctx | UniverRenderingContext |
bounds ? | IViewportInfo |
Returns
void
Defined in
submodules/univer/packages/engine-render/src/components/component.ts:61 (opens in a new tab)
ensureNotDisposed()
protected ensureNotDisposed(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)
flip()
flip(flipX?, flipY?): RenderComponent<T, U, V>
Parameters
Parameter | Type |
---|---|
flipX ? | boolean |
flipY ? | boolean |
Returns
RenderComponent
<T
, U
, V
>
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:522 (opens in a new tab)
getEngine()
getEngine(): Nullable<Engine>
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:824 (opens in a new tab)
getExtensionByKey()
getExtensionByKey(uKey): undefined | ComponentExtension<T, U, V>
Parameters
Parameter | Type |
---|---|
uKey | string |
Returns
undefined
| ComponentExtension
<T
, U
, V
>
Defined in
submodules/univer/packages/engine-render/src/components/component.ts:57 (opens in a new tab)
getExtensionsByOrder()
getExtensionsByOrder(): ComponentExtension<T, U, V>[]
Returns
ComponentExtension
<T
, U
, V
>[]
Defined in
submodules/univer/packages/engine-render/src/components/component.ts:50 (opens in a new tab)
getInverseCoord()
getInverseCoord(coord): Vector2
Parameters
Parameter | Type |
---|---|
coord | Vector2 |
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:854 (opens in a new tab)
getLayerIndex()
getLayerIndex(): number
Returns
number
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:839 (opens in a new tab)
getObjects()
getObjects(): BaseObject[]
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:835 (opens in a new tab)
getParent()
getParent(): any
Returns
any
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:580 (opens in a new tab)
getScene()
getScene(): Nullable<Scene>
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:796 (opens in a new tab)
getState()
getState(): ITransformState
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:584 (opens in a new tab)
hide()
hide(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:600 (opens in a new tab)
isDirty()
isDirty(): boolean
Returns
boolean
Inherited from
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
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:614 (opens in a new tab)
isRender()
isRender(bounds?): undefined | boolean
Parameters
Parameter | Type |
---|---|
bounds ? | IViewportInfo |
Returns
undefined
| boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:573 (opens in a new tab)
makeDirty()
makeDirty(state): undefined | RenderComponent<T, U, V>
Parameters
Parameter | Type | Default value |
---|---|---|
state | boolean | true |
Returns
undefined
| RenderComponent
<T
, U
, V
>
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:403 (opens in a new tab)
makeDirtyNoDebounce()
makeDirtyNoDebounce(state): RenderComponent<T, U, V>
Parameters
Parameter | Type | Default value |
---|---|---|
state | boolean | true |
Returns
RenderComponent
<T
, U
, V
>
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
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:418 (opens in a new tab)
register()
register(...extensions): IDisposable
Parameters
Parameter | Type |
---|---|
...extensions | ComponentExtension <T , U , V >[] |
Returns
Defined in
submodules/univer/packages/engine-render/src/components/component.ts:31 (opens in a new tab)
removeTransform()
removeTransform(): void
Returns
void
Inherited from
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
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:610 (opens in a new tab)
resetCursor()
resetCursor(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:815 (opens in a new tab)
resize()
resize(width?, height?): RenderComponent<T, U, V>
Parameters
Parameter | Type |
---|---|
width ? | string | number |
height ? | string | number |
Returns
RenderComponent
<T
, U
, V
>
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:457 (opens in a new tab)
scale()
scale(scaleX?, scaleY?): RenderComponent<T, U, V>
Parameters
Parameter | Type |
---|---|
scaleX ? | number |
scaleY ? | number |
Returns
RenderComponent
<T
, U
, V
>
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:478 (opens in a new tab)
setCursor()
setCursor(val): void
Parameters
Parameter | Type |
---|---|
val | CURSOR_TYPE |
Returns
void
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:819 (opens in a new tab)
show()
show(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:605 (opens in a new tab)
skew()
skew(skewX?, skewY?): RenderComponent<T, U, V>
Parameters
Parameter | Type |
---|---|
skewX ? | number |
skewY ? | number |
Returns
RenderComponent
<T
, U
, V
>
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:500 (opens in a new tab)
toJson()
toJson(): IKeyValue
Returns
IKeyValue
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:785 (opens in a new tab)
transformByState()
transformByState(option): undefined | RenderComponent<T, U, V>
this[pKey] = option[pKey]
Parameters
Parameter | Type |
---|---|
option | IObjectFullState |
Returns
undefined
| RenderComponent
<T
, U
, V
>
Inherited from
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
Inherited from
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:153 (opens in a new tab)
translate()
translate(x?, y?): RenderComponent<T, U, V>
Parameters
Parameter | Type |
---|---|
x ? | string | number |
y ? | string | number |
Returns
RenderComponent
<T
, U
, V
>
Inherited from
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
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
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
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
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
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
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
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
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
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
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
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
Defined in
submodules/univer/packages/engine-render/src/base-object.ts:661 (opens in a new tab)