@univerjs/engine-render v0.4.2 • Docs

Class: Documents

Extends

• DocComponent

Constructors

new Documents()

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

Parameters

Returns

Documents

Overrides

DocComponent.constructor

Defined in

submodules/univer/packages/engine-render/src/components/docs/document.ts:61 (opens in a new tab)

Properties

Accessors

ancestorGroup

get ancestorGroup(): Nullable<BaseObject>

Returns

Nullable<BaseObject>

Inherited from

DocComponent.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

DocComponent.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

DocComponent.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

DocComponent.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

DocComponent.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

DocComponent.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

Returns

number

Inherited from

DocComponent.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

Inherited from

DocComponent.classType

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

Returns

CURSOR_TYPE

Inherited from

DocComponent.cursor

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

Returns

boolean

Inherited from

DocComponent.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

Returns

boolean

Inherited from

DocComponent.evented

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>>

Inherited from

DocComponent.extensions

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

Returns

boolean

Inherited from

DocComponent.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

Returns

boolean

Inherited from

DocComponent.flipY

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

Returns

number

Inherited from

DocComponent.height

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

DocComponent.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

Returns

Nullable<Layer>

Inherited from

DocComponent.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

Returns

number

Inherited from

DocComponent.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

DocComponent.leftOrigin

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

DocComponent.maxZIndex

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

DocComponent.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

Returns

any

Inherited from

DocComponent.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

DocComponent.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

Returns

number

Inherited from

DocComponent.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

Returns

number

Inherited from

DocComponent.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

Returns

number

Inherited from

DocComponent.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

Returns

number

Inherited from

DocComponent.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

Returns

number

Inherited from

DocComponent.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

Returns

number

Inherited from

DocComponent.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

DocComponent.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

Returns

Transform

Inherited from

DocComponent.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

Returns

ITransformerConfig

Inherited from

DocComponent.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

DocComponent.visible

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

Returns

number

Inherited from

DocComponent.width

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

DocComponent.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

Returns

number

Inherited from

DocComponent.zIndex

Defined in

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

Methods

_draw()

protected _draw(ctx, bounds?): void

Parameters

Returns

void

Overrides

DocComponent._draw

Defined in

submodules/univer/packages/engine-render/src/components/docs/document.ts:110 (opens in a new tab)

_setTransForm()

protected _setTransForm(): void

Returns

void

Inherited from

DocComponent._setTransForm

Defined in

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

applyTransform()

applyTransform(): void

Returns

void

Inherited from

DocComponent.applyTransform

Defined in

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

changeSkeleton()

changeSkeleton(newSkeleton): Documents

Parameters

Returns

Documents

Defined in

submodules/univer/packages/engine-render/src/components/docs/document.ts:104 (opens in a new tab)

dispose()

dispose(): void

Returns

void

Overrides

DocComponent.dispose

Defined in

submodules/univer/packages/engine-render/src/components/docs/document.ts:73 (opens in a new tab)

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Returns

IDisposable

Inherited from

DocComponent.disposeWithMe

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)

draw()

draw(ctx, bounds?): void

Parameters

Returns

void

Overrides

DocComponent.draw

Defined in

submodules/univer/packages/engine-render/src/components/docs/document.ts:114 (opens in a new tab)

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

DocComponent.ensureNotDisposed

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)

flip()

flip(flipX?, flipY?): Documents

Parameters

Returns

Documents

Inherited from

DocComponent.flip

Defined in

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

getEngine()

getEngine(): Nullable<Engine>

Returns

Nullable<Engine>

Overrides

DocComponent.getEngine

Defined in

submodules/univer/packages/engine-render/src/components/docs/document.ts:100 (opens in a new tab)

getExtensionByKey()

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

Parameters

Returns

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

Inherited from

DocComponent.getExtensionByKey

Defined in

submodules/univer/packages/engine-render/src/components/component.ts:57 (opens in a new tab)

getExtensionsByOrder()

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

Returns

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

Inherited from

DocComponent.getExtensionsByOrder

Defined in

submodules/univer/packages/engine-render/src/components/component.ts:50 (opens in a new tab)

getInverseCoord()

getInverseCoord(coord): Vector2

Parameters

Returns

Vector2

Inherited from

DocComponent.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

DocComponent.getLayerIndex

Defined in

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

getObjects()

getObjects(): BaseObject[]

Returns

BaseObject[]

Inherited from

DocComponent.getObjects

Defined in

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

getOffsetConfig()

getOffsetConfig(): IDocumentOffsetConfig

Returns

IDocumentOffsetConfig

Defined in

submodules/univer/packages/engine-render/src/components/docs/document.ts:80 (opens in a new tab)

getParent()

getParent(): any

Returns

any

Inherited from

DocComponent.getParent

Defined in

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

getParentScale()

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

Returns

{
  scaleX: any;
  scaleY: any;
}

Inherited from

DocComponent.getParentScale

Defined in

submodules/univer/packages/engine-render/src/components/docs/doc-component.ts:104 (opens in a new tab)

getScene()

getScene(): Nullable<Scene>

Returns

Nullable<Scene>

Inherited from

DocComponent.getScene

Defined in

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

getSkeleton()

getSkeleton(): undefined | DocumentSkeleton

Returns

undefined | DocumentSkeleton

Inherited from

DocComponent.getSkeleton

Defined in

submodules/univer/packages/engine-render/src/components/docs/doc-component.ts:57 (opens in a new tab)

getState()

getState(): ITransformState

Returns

ITransformState

Inherited from

DocComponent.getState

Defined in

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

hide()

hide(): void

Returns

void

Inherited from

DocComponent.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

DocComponent.isDirty

Defined in

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

isHit()

isHit(coord): boolean

Parameters

Returns

boolean

Inherited from

DocComponent.isHit

Defined in

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

isRender()

isRender(bounds?): undefined | boolean

Parameters

Returns

undefined | boolean

Inherited from

DocComponent.isRender

Defined in

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

isSkipByDiffBounds()

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

Parameters

Returns

boolean

Inherited from

DocComponent.isSkipByDiffBounds

Defined in

submodules/univer/packages/engine-render/src/components/docs/doc-component.ts:121 (opens in a new tab)

makeDirty()

makeDirty(state): undefined | Documents

Parameters

Returns

undefined | Documents

Inherited from

DocComponent.makeDirty

Defined in

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

makeDirtyNoDebounce()

makeDirtyNoDebounce(state): Documents

Parameters

Returns

Documents

Inherited from

DocComponent.makeDirtyNoDebounce

Defined in

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

makeForceDirty()

makeForceDirty(state): void

Parameters

Returns

void

Inherited from

DocComponent.makeForceDirty

Defined in

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

register()

register(...extensions): IDisposable

Parameters

Returns

IDisposable

Inherited from

DocComponent.register

Defined in

submodules/univer/packages/engine-render/src/components/component.ts:31 (opens in a new tab)

removeTransform()

removeTransform(): void

Returns

void

Inherited from

DocComponent.removeTransform

Defined in

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

render()

render(mainCtx, bounds?): undefined | Documents

Parameters

Returns

undefined | Documents

Inherited from

DocComponent.render

Defined in

submodules/univer/packages/engine-render/src/components/docs/doc-component.ts:85 (opens in a new tab)

resetCursor()

resetCursor(): void

Returns

void

Inherited from

DocComponent.resetCursor

Defined in

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

resize()

resize(width?, height?): Documents

Parameters

Returns

Documents

Inherited from

DocComponent.resize

Defined in

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

scale()

scale(scaleX?, scaleY?): Documents

Parameters

Returns

Documents

Inherited from

DocComponent.scale

Defined in

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

setCursor()

setCursor(val): void

Parameters

Returns

void

Inherited from

DocComponent.setCursor

Defined in

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

setSkeleton()

setSkeleton(skeleton): void

Parameters

Returns

void

Inherited from

DocComponent.setSkeleton

Defined in

submodules/univer/packages/engine-render/src/components/docs/doc-component.ts:61 (opens in a new tab)

show()

show(): void

Returns

void

Inherited from

DocComponent.show

Defined in

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

skew()

skew(skewX?, skewY?): Documents

Parameters

Returns

Documents

Inherited from

DocComponent.skew

Defined in

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

toJson()

toJson(): IKeyValue

Returns

IKeyValue

Inherited from

DocComponent.toJson

Defined in

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

transformByState()

transformByState(option): undefined | Documents

this[pKey] = option[pKey]

Parameters

Returns

undefined | Documents

Inherited from

DocComponent.transformByState

Defined in

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

transformForAngle()

transformForAngle(transform): Transform

Parameters

Returns

Transform

Inherited from

DocComponent.transformForAngle

Defined in

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

translate()

translate(x?, y?): Documents

Parameters

Returns

Documents

Inherited from

DocComponent.translate

Defined in

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

triggerDblclick()

triggerDblclick(evt): boolean

Parameters

Returns

boolean

Inherited from

DocComponent.triggerDblclick

Defined in

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

triggerDragEnter()

triggerDragEnter(evt): boolean

Parameters

Returns

boolean

Inherited from

DocComponent.triggerDragEnter

Defined in

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

triggerDragLeave()

triggerDragLeave(evt): boolean

Parameters

Returns

boolean

Inherited from

DocComponent.triggerDragLeave

Defined in

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

triggerDragOver()

triggerDragOver(evt): boolean

Parameters

Returns

boolean

Inherited from

DocComponent.triggerDragOver

Defined in

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

triggerDrop()

triggerDrop(evt): boolean

Parameters

Returns

boolean

Inherited from

DocComponent.triggerDrop

Defined in

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

triggerMouseWheel()

triggerMouseWheel(evt): boolean

Parameters

Returns

boolean

Inherited from

DocComponent.triggerMouseWheel

Defined in

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

triggerPointerDown()

triggerPointerDown(evt): boolean

Parameters

Returns

boolean

Inherited from

DocComponent.triggerPointerDown

Defined in

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

triggerPointerEnter()

triggerPointerEnter(evt): boolean

Parameters

Returns

boolean

Inherited from

DocComponent.triggerPointerEnter

Defined in

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

triggerPointerLeave()

triggerPointerLeave(evt): boolean

Parameters

Returns

boolean

Inherited from

DocComponent.triggerPointerLeave

Defined in

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

triggerPointerMove()

triggerPointerMove(evt): boolean

Parameters

Returns

boolean

Inherited from

DocComponent.triggerPointerMove

Defined in

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

triggerPointerOut()

triggerPointerOut(evt): boolean

Parameters

Returns

boolean

Inherited from

DocComponent.triggerPointerOut

Defined in

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

triggerPointerOver()

triggerPointerOver(evt): boolean

Parameters

Returns

boolean

Inherited from

DocComponent.triggerPointerOver

Defined in

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

triggerPointerUp()

triggerPointerUp(evt): boolean

Parameters

Returns

boolean

Inherited from

DocComponent.triggerPointerUp

Defined in

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

triggerTripleClick()

triggerTripleClick(evt): boolean

Parameters

Returns

boolean

Inherited from

DocComponent.triggerTripleClick

Defined in

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

create()

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

Parameters

Returns

Documents

Defined in

submodules/univer/packages/engine-render/src/components/docs/document.ts:69 (opens in a new tab)