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

Class: DocBackground

Extends

DocComponent

Constructors

new DocBackground()

new DocBackground(
   oKey, 
   documentSkeleton?, 
   config?): DocBackground

Parameters

Parameter	Type
`oKey`	`string`
`documentSkeleton`?	`DocumentSkeleton`
`config`?	`IDocumentsConfig`

Returns

DocBackground

Overrides

DocComponent.constructor

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/doc-background.ts:34

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_dirty`	`protected`	`boolean`	`true`	`DocComponent._dirty`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:88
`_disposed`	`protected`	`boolean`	`false`	`DocComponent._disposed`	packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:93
`_forceDirty`	`protected`	`boolean`	`true`	`DocComponent._forceDirty`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:89
`_oKey`	`protected`	`string`	`undefined`	`DocComponent._oKey`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:86
`groupKey?`	`public`	`string`	`undefined`	`DocComponent.groupKey`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:59
`isInGroup`	`public`	`boolean`	`false`	`DocComponent.isInGroup`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:60
`objectType`	`public`	`ObjectType`	`ObjectType.UNKNOWN`	`DocComponent.objectType`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:62
`onDblclick$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`DocComponent.onDblclick$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:74
`onDispose$`	`public`	`EventSubject`<`BaseObject`>	`undefined`	`DocComponent.onDispose$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:84
`onDragEnter$`	`public`	`EventSubject`<`IMouseEvent` \| `IDragEvent`>	`undefined`	`DocComponent.onDragEnter$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:80
`onDragLeave$`	`public`	`EventSubject`<`IMouseEvent` \| `IDragEvent`>	`undefined`	`DocComponent.onDragLeave$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:78
`onDragOver$`	`public`	`EventSubject`<`IMouseEvent` \| `IDragEvent`>	`undefined`	`DocComponent.onDragOver$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:79
`onDrop$`	`public`	`EventSubject`<`IMouseEvent` \| `IDragEvent`>	`undefined`	`DocComponent.onDrop$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:81
`onIsAddedToParent$`	`public`	`EventSubject`<`any`>	`undefined`	`DocComponent.onIsAddedToParent$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:83
`onMouseWheel$`	`public`	`EventSubject`<`IWheelEvent`>	`undefined`	`DocComponent.onMouseWheel$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:76
`onPointerDown$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`DocComponent.onPointerDown$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:66
`onPointerEnter$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`DocComponent.onPointerEnter$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:72
`onPointerLeave$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`DocComponent.onPointerLeave$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:71
`onPointerMove$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`DocComponent.onPointerMove$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:67
`onPointerOut$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`DocComponent.onPointerOut$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:69
`onPointerOver$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`DocComponent.onPointerOver$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:70
`onPointerUp$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`DocComponent.onPointerUp$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:68
`onTransformChange$`	`public`	`EventSubject`<`ITransformChangeState`>	`undefined`	`DocComponent.onTransformChange$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:64
`onTripleClick$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`DocComponent.onTripleClick$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:75
`pageLayoutType`	`public`	`PageLayoutType`	`PageLayoutType.VERTICAL`	`DocComponent.pageLayoutType`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/doc-component.ts:45
`pageMarginLeft`	`public`	`number`	`0`	`DocComponent.pageMarginLeft`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/doc-component.ts:41
`pageMarginTop`	`public`	`number`	`0`	`DocComponent.pageMarginTop`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/doc-component.ts:43

Accessors

ancestorGroup

Get Signature

get ancestorGroup(): Nullable<BaseObject>

Returns

Nullable<BaseObject>

Inherited from

DocComponent.ancestorGroup

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

Inherited from

DocComponent.ancestorLeft

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

Inherited from

DocComponent.ancestorScaleX

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

Inherited from

DocComponent.ancestorScaleY

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

Inherited from

DocComponent.ancestorTop

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

Inherited from

DocComponent.ancestorTransform

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

Parameter	Type
`angle`	`number`

Returns

void

Inherited from

DocComponent.angle

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

Inherited from

DocComponent.classType

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

Parameter	Type
`val`	`CURSOR_TYPE`

Returns

void

Inherited from

DocComponent.cursor

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

Parameter	Type
`state`	`boolean`

Returns

void

Inherited from

DocComponent.debounceParentDirty

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

Parameter	Type
`state`	`boolean`

Returns

void

Inherited from

DocComponent.evented

Defined in

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

extensions

Get Signature

get extensions(): Map<string, ComponentExtension<T, U, V>>

Returns

Map<string, ComponentExtension<T, U, V>>

Inherited from

DocComponent.extensions

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/component.ts:27

flipX

Get Signature

get flipX(): boolean

Returns

boolean

Set Signature

set flipX(flipX): void

Parameters

Parameter	Type
`flipX`	`boolean`

Returns

void

Inherited from

DocComponent.flipX

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

Parameter	Type
`flipY`	`boolean`

Returns

void

Inherited from

DocComponent.flipY

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

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

Returns

void

Inherited from

DocComponent.height

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

Inherited from

DocComponent.heightOrigin

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

Parameter	Type
`layer`	`Layer`

Returns

void

Inherited from

DocComponent.layer

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

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

Returns

void

Inherited from

DocComponent.left

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

Inherited from

DocComponent.leftOrigin

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

Inherited from

DocComponent.maxZIndex

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

Inherited from

DocComponent.oKey

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

Parameter	Type
`o`	`any`

Returns

void

Inherited from

DocComponent.parent

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

Inherited from

DocComponent.printable

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

Parameter	Type
`scaleX`	`number`

Returns

void

Inherited from

DocComponent.scaleX

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

Parameter	Type
`scaleY`	`number`

Returns

void

Inherited from

DocComponent.scaleY

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

Parameter	Type
`skewX`	`number`

Returns

void

Inherited from

DocComponent.skewX

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

Parameter	Type
`skewY`	`number`

Returns

void

Inherited from

DocComponent.skewY

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

Parameter	Type
`width`	`number`

Returns

void

Inherited from

DocComponent.strokeWidth

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

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

Returns

void

Inherited from

DocComponent.top

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

Inherited from

DocComponent.topOrigin

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

Parameter	Type
`trans`	`Transform`

Returns

void

Inherited from

DocComponent.transform

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

Parameter	Type
`config`	`ITransformerConfig`

Returns

void

Inherited from

DocComponent.transformerConfig

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

Inherited from

DocComponent.visible

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

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

Returns

void

Inherited from

DocComponent.width

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

Inherited from

DocComponent.widthOrigin

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

Parameter	Type
`index`	`number`

Returns

void

Inherited from

DocComponent.zIndex

Defined in

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

Methods

_draw()

protected _draw(ctx, bounds?): void

Parameters

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

Returns

void

Overrides

DocComponent._draw

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/doc-background.ts:163

_setTransForm()

protected _setTransForm(): void

Returns

void

Inherited from

DocComponent._setTransForm

Defined in

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

applyTransform()

applyTransform(): void

Returns

void

Inherited from

DocComponent.applyTransform

Defined in

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

changeSkeleton()

changeSkeleton(newSkeleton): DocBackground

Parameters

Parameter	Type
`newSkeleton`	`DocumentSkeleton`

Returns

DocBackground

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/doc-background.ts:157

dispose()

dispose(): void

Returns

void

Inherited from

DocComponent.dispose

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/component.ts:65

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

DocComponent.disposeWithMe

Defined in

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

draw()

draw(ctx, bounds?): void

Parameters

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

Returns

void

Overrides

DocComponent.draw

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/doc-background.ts:46

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

DocComponent.ensureNotDisposed

Defined in

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

flip()

flip(flipX?, flipY?): DocBackground

Parameters

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

Returns

DocBackground

Inherited from

DocComponent.flip

Defined in

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

getEngine()

getEngine(): Nullable<Engine>

Returns

Nullable<Engine>

Inherited from

DocComponent.getEngine

Defined in

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

getExtensionByKey()

getExtensionByKey(uKey): undefined | ComponentExtension<IDocumentSkeletonLine | IDocumentSkeletonGlyph, DOCS_EXTENSION_TYPE, IBoundRectNoAngle[]>

Parameters

Parameter	Type
`uKey`	`string`

Returns

undefined | ComponentExtension<IDocumentSkeletonLine | IDocumentSkeletonGlyph, DOCS_EXTENSION_TYPE, IBoundRectNoAngle[]>

Inherited from

DocComponent.getExtensionByKey

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/component.ts:57

getExtensionsByOrder()

getExtensionsByOrder(): ComponentExtension<IDocumentSkeletonLine | IDocumentSkeletonGlyph, DOCS_EXTENSION_TYPE, IBoundRectNoAngle[]>[]

Returns

ComponentExtension<IDocumentSkeletonLine | IDocumentSkeletonGlyph, DOCS_EXTENSION_TYPE, IBoundRectNoAngle[]>[]

Inherited from

DocComponent.getExtensionsByOrder

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/component.ts:50

getInverseCoord()

getInverseCoord(coord): Vector2

Parameters

Parameter	Type
`coord`	`Vector2`

getParentScale()

getParentScale(): {
  scaleX: any;
  scaleY: any;
}

Returns

{
  scaleX: any;
  scaleY: any;
}

Name	Type	Defined in
`scaleX`	`any`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/doc-component.ts:116
`scaleY`	`any`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/doc-component.ts:117

Inherited from

DocComponent.getParentScale

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/doc-component.ts:104

getScene()

getScene(): Nullable<Scene>

Defined in

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

isHit()

isHit(coord): boolean

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

boolean

Inherited from

DocComponent.isHit

Defined in

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

isRender()

isRender(bounds?): undefined | boolean

Parameters

Parameter	Type
`bounds`?	`IViewportInfo`

Returns

undefined | boolean

Inherited from

DocComponent.isRender

Defined in

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

isSkipByDiffBounds()

isSkipByDiffBounds(
   page, 
   pageTop, 
   pageLeft, 
   bounds?): boolean

Parameters

Parameter	Type
`page`	`IDocumentSkeletonPage`
`pageTop`	`number`
`pageLeft`	`number`
`bounds`?	`IViewportInfo`

Returns

boolean

Inherited from

DocComponent.isSkipByDiffBounds

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/doc-component.ts:121

makeDirty()

makeDirty(state): undefined | DocBackground

Parameters

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

Returns

undefined | DocBackground

Inherited from

DocComponent.makeDirty

Defined in

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

makeDirtyNoDebounce()

makeDirtyNoDebounce(state): DocBackground

Parameters

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

Returns

DocBackground

Inherited from

DocComponent.makeDirtyNoDebounce

Defined in

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

makeForceDirty()

makeForceDirty(state): void

Parameters

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

Returns

void

Inherited from

DocComponent.makeForceDirty

Defined in

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

register()

register(...extensions): IDisposable

Parameters

Parameter	Type
…`extensions`	`ComponentExtension`<`IDocumentSkeletonLine` \| `IDocumentSkeletonGlyph`, `DOCS_EXTENSION_TYPE`, `IBoundRectNoAngle`[]>[]

Returns

IDisposable

Inherited from

DocComponent.register

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/component.ts:31

removeTransform()

removeTransform(): void

Returns

void

Inherited from

DocComponent.removeTransform

Defined in

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

render()

render(mainCtx, bounds?): undefined | DocBackground

Parameters

Parameter	Type
`mainCtx`	`UniverRenderingContext`
`bounds`?	`IViewportInfo`

Returns

undefined | DocBackground

Inherited from

DocComponent.render

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/doc-component.ts:85

resetCursor()

resetCursor(): void

Returns

void

Inherited from

DocComponent.resetCursor

Defined in

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

resize()

resize(width?, height?): DocBackground

Parameters

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

Returns

DocBackground

Inherited from

DocComponent.resize

Defined in

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

scale()

scale(scaleX?, scaleY?): DocBackground

Parameters

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

Returns

DocBackground

Inherited from

DocComponent.scale

Defined in

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

setCursor()

setCursor(val): void

Parameters

Parameter	Type
`val`	`CURSOR_TYPE`

Returns

void

Inherited from

DocComponent.setCursor

Defined in

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

setSkeleton()

setSkeleton(skeleton): void

Parameters

Parameter	Type
`skeleton`	`DocumentSkeleton`

Returns

void

Inherited from

DocComponent.setSkeleton

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/doc-component.ts:61

show()

show(): void

Returns

void

Inherited from

DocComponent.show

Defined in

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

skew()

skew(skewX?, skewY?): DocBackground

Parameters

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

Returns

DocBackground

Inherited from

DocComponent.skew

Defined in

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

toJson()

toJson(): IKeyValue

Returns

IKeyValue

Inherited from

DocComponent.toJson

Defined in

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

transformByState()

transformByState(option): undefined | DocBackground

this[pKey] = option[pKey]

Parameters

Parameter	Type
`option`	`IObjectFullState`

Returns

undefined | DocBackground

Inherited from

DocComponent.transformByState

Defined in

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

transformForAngle()

transformForAngle(transform): Transform

Parameters

Parameter	Type
`transform`	`Transform`

Returns

Transform

Inherited from

DocComponent.transformForAngle

Defined in

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

translate()

translate(x?, y?): DocBackground

Parameters

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

Returns

DocBackground

Inherited from

DocComponent.translate

Defined in

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

triggerDblclick()

triggerDblclick(evt): boolean

Parameters

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

Returns

boolean

Inherited from

DocComponent.triggerDblclick

Defined in

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

triggerDragEnter()

triggerDragEnter(evt): boolean

Parameters

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

Returns

boolean

Inherited from

DocComponent.triggerDragEnter

Defined in

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

triggerDragLeave()

triggerDragLeave(evt): boolean

Parameters

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

Returns

boolean

Inherited from

DocComponent.triggerDragLeave

Defined in

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

triggerDragOver()

triggerDragOver(evt): boolean

Parameters

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

Returns

boolean

Inherited from

DocComponent.triggerDragOver

Defined in

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

triggerDrop()

triggerDrop(evt): boolean

Parameters

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

Returns

boolean

Inherited from

DocComponent.triggerDrop

Defined in

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

triggerMouseWheel()

triggerMouseWheel(evt): boolean

Parameters

Parameter	Type
`evt`	`IWheelEvent`

Returns

boolean

Inherited from

DocComponent.triggerMouseWheel

Defined in

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

triggerPointerDown()

triggerPointerDown(evt): boolean

Parameters

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

Returns

boolean

Inherited from

DocComponent.triggerPointerDown

Defined in

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

triggerPointerEnter()

triggerPointerEnter(evt): boolean

Parameters

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

Returns

boolean

Inherited from

DocComponent.triggerPointerEnter

Defined in

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

triggerPointerLeave()

triggerPointerLeave(evt): boolean

Parameters

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

Returns

boolean

Inherited from

DocComponent.triggerPointerLeave

Defined in

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

triggerPointerMove()

triggerPointerMove(evt): boolean

Parameters

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

Returns

boolean

Inherited from

DocComponent.triggerPointerMove

Defined in

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

triggerPointerOut()

triggerPointerOut(evt): boolean

Parameters

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

Returns

boolean

Inherited from

DocComponent.triggerPointerOut

Defined in

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

triggerPointerOver()

triggerPointerOver(evt): boolean

Parameters

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

Returns

boolean

Inherited from

DocComponent.triggerPointerOver

Defined in

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

triggerPointerUp()

triggerPointerUp(evt): boolean

Parameters

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

Returns

boolean

Inherited from

DocComponent.triggerPointerUp

Defined in

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

triggerTripleClick()

triggerTripleClick(evt): boolean

Parameters

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

Returns

boolean

Inherited from

DocComponent.triggerTripleClick

Defined in

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

create()

static create(
   oKey, 
   documentSkeleton?, 
   config?): DocBackground

Parameters

Parameter	Type
`oKey`	`string`
`documentSkeleton`?	`DocumentSkeleton`
`config`?	`IDocumentsConfig`

Returns

DocBackground

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/docs/doc-background.ts:42

Datastreamtreenode Documentskeleton