API Reference
@univerjs
@univerjs/engine-render
classes
Spreadsheet

@univerjs/engine-render v0.1.17Docs


Class: Spreadsheet

Extends

Constructors

new Spreadsheet()

new Spreadsheet(
   oKey, 
   spreadsheetSkeleton?, 
   _allowCache?): Spreadsheet

Parameters

ParameterTypeDefault value
oKeystringundefined
spreadsheetSkeleton?SpreadsheetSkeletonundefined
_allowCache?booleantrue

Returns

Spreadsheet

Overrides

SheetComponent.constructor

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:63 (opens in a new tab)

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_dirtyprotectedbooleantrueSheetComponent._dirtysubmodules/univer/packages/engine-render/src/base-object.ts:74 (opens in a new tab)
_disposedprotectedbooleanfalseSheetComponent._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
_forceDirtyprotectedbooleantrueSheetComponent._forceDirtysubmodules/univer/packages/engine-render/src/base-object.ts:75 (opens in a new tab)
_oKeyprotectedstringundefinedSheetComponent._oKeysubmodules/univer/packages/engine-render/src/base-object.ts:72 (opens in a new tab)
groupKey?publicstringundefinedSheetComponent.groupKeysubmodules/univer/packages/engine-render/src/base-object.ts:47 (opens in a new tab)
isInGrouppublicbooleanfalseSheetComponent.isInGroupsubmodules/univer/packages/engine-render/src/base-object.ts:48 (opens in a new tab)
isPrintingpublicbooleanfalse-submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:61 (opens in a new tab)
onDblclick$publicEventSubject<IMouseEvent | IPointerEvent>undefinedSheetComponent.onDblclick$submodules/univer/packages/engine-render/src/base-object.ts:60 (opens in a new tab)
onDispose$publicEventSubject<BaseObject>undefinedSheetComponent.onDispose$submodules/univer/packages/engine-render/src/base-object.ts:70 (opens in a new tab)
onDragEnter$publicEventSubject<IMouseEvent | IDragEvent>undefinedSheetComponent.onDragEnter$submodules/univer/packages/engine-render/src/base-object.ts:66 (opens in a new tab)
onDragLeave$publicEventSubject<IMouseEvent | IDragEvent>undefinedSheetComponent.onDragLeave$submodules/univer/packages/engine-render/src/base-object.ts:64 (opens in a new tab)
onDragOver$publicEventSubject<IMouseEvent | IDragEvent>undefinedSheetComponent.onDragOver$submodules/univer/packages/engine-render/src/base-object.ts:65 (opens in a new tab)
onDrop$publicEventSubject<IMouseEvent | IDragEvent>undefinedSheetComponent.onDrop$submodules/univer/packages/engine-render/src/base-object.ts:67 (opens in a new tab)
onIsAddedToParent$publicEventSubject<any>undefinedSheetComponent.onIsAddedToParent$submodules/univer/packages/engine-render/src/base-object.ts:69 (opens in a new tab)
onMouseWheel$publicEventSubject<IWheelEvent>undefinedSheetComponent.onMouseWheel$submodules/univer/packages/engine-render/src/base-object.ts:62 (opens in a new tab)
onPointerDown$publicEventSubject<IMouseEvent | IPointerEvent>undefinedSheetComponent.onPointerDown$submodules/univer/packages/engine-render/src/base-object.ts:52 (opens in a new tab)
onPointerEnter$publicEventSubject<IMouseEvent | IPointerEvent>undefinedSheetComponent.onPointerEnter$submodules/univer/packages/engine-render/src/base-object.ts:58 (opens in a new tab)
onPointerLeave$publicEventSubject<IMouseEvent | IPointerEvent>undefinedSheetComponent.onPointerLeave$submodules/univer/packages/engine-render/src/base-object.ts:57 (opens in a new tab)
onPointerMove$publicEventSubject<IMouseEvent | IPointerEvent>undefinedSheetComponent.onPointerMove$submodules/univer/packages/engine-render/src/base-object.ts:53 (opens in a new tab)
onPointerOut$publicEventSubject<IMouseEvent | IPointerEvent>undefinedSheetComponent.onPointerOut$submodules/univer/packages/engine-render/src/base-object.ts:55 (opens in a new tab)
onPointerOver$publicEventSubject<IMouseEvent | IPointerEvent>undefinedSheetComponent.onPointerOver$submodules/univer/packages/engine-render/src/base-object.ts:56 (opens in a new tab)
onPointerUp$publicEventSubject<IMouseEvent | IPointerEvent>undefinedSheetComponent.onPointerUp$submodules/univer/packages/engine-render/src/base-object.ts:54 (opens in a new tab)
onTransformChange$publicEventSubject<ITransformChangeState>undefinedSheetComponent.onTransformChange$submodules/univer/packages/engine-render/src/base-object.ts:50 (opens in a new tab)
onTripleClick$publicEventSubject<IMouseEvent | IPointerEvent>undefinedSheetComponent.onTripleClick$submodules/univer/packages/engine-render/src/base-object.ts:61 (opens in a new tab)

Accessors

allowCache

get allowCache(): boolean

Returns

boolean

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:90 (opens in a new tab)


ancestorGroup

get ancestorGroup(): Nullable<BaseObject>

Returns

Nullable<BaseObject>

Inherited from

SheetComponent.ancestorGroup

Defined in

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


ancestorLeft

get ancestorLeft(): any

Returns

any

Inherited from

SheetComponent.ancestorLeft

Defined in

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


ancestorScaleX

get ancestorScaleX(): number

Returns

number

Inherited from

SheetComponent.ancestorScaleX

Defined in

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


ancestorScaleY

get ancestorScaleY(): number

Returns

number

Inherited from

SheetComponent.ancestorScaleY

Defined in

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


ancestorTop

get ancestorTop(): any

Returns

any

Inherited from

SheetComponent.ancestorTop

Defined in

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


ancestorTransform

get ancestorTransform(): any

Returns

any

Inherited from

SheetComponent.ancestorTransform

Defined in

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


angle

get angle(): number
set angle(angle): void

Parameters

ParameterType
anglenumber

Returns

number

Inherited from

SheetComponent.angle

Defined in

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


backgroundExtension

get backgroundExtension(): Background

Returns

Background

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:74 (opens in a new tab)


borderExtension

get borderExtension(): Border

Returns

Border

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:78 (opens in a new tab)


classType

get classType(): RENDER_CLASS_TYPE

Returns

RENDER_CLASS_TYPE

Inherited from

SheetComponent.classType

Defined in

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


cursor

get cursor(): CURSOR_TYPE
set cursor(val): void

Parameters

ParameterType
valCURSOR_TYPE

Returns

CURSOR_TYPE

Inherited from

SheetComponent.cursor

Defined in

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


debounceParentDirty

get debounceParentDirty(): boolean
set debounceParentDirty(state): void

Parameters

ParameterType
stateboolean

Returns

boolean

Inherited from

SheetComponent.debounceParentDirty

Defined in

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


evented

get evented(): boolean
set evented(state): void

Parameters

ParameterType
stateboolean

Returns

boolean

Inherited from

SheetComponent.evented

Defined in

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


extensions

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

Returns

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

Inherited from

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

ParameterType
flipXboolean

Returns

boolean

Inherited from

SheetComponent.flipX

Defined in

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


flipY

get flipY(): boolean
set flipY(flipY): void

Parameters

ParameterType
flipYboolean

Returns

boolean

Inherited from

SheetComponent.flipY

Defined in

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


fontExtension

get fontExtension(): Font

Returns

Font

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:82 (opens in a new tab)


forceDisableGridlines

get forceDisableGridlines(): boolean

Returns

boolean

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:94 (opens in a new tab)


height

get height(): number
set height(num): void

Parameters

ParameterType
numstring | number

Returns

number

Inherited from

SheetComponent.height

Defined in

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


heightOrigin

get heightOrigin(): string | number

Returns

string | number

Inherited from

SheetComponent.heightOrigin

Defined in

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


layer

get layer(): Nullable<Layer>
set layer(layer): void

Parameters

ParameterType
layerLayer

Returns

Nullable<Layer>

Inherited from

SheetComponent.layer

Defined in

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


left

get left(): number
set left(num): void

Parameters

ParameterType
numstring | number

Returns

number

Inherited from

SheetComponent.left

Defined in

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


leftOrigin

get leftOrigin(): string | number

Returns

string | number

Inherited from

SheetComponent.leftOrigin

Defined in

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


maxZIndex

get maxZIndex(): number

Returns

number

Inherited from

SheetComponent.maxZIndex

Defined in

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


oKey

get oKey(): string

Returns

string

Inherited from

SheetComponent.oKey

Defined in

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


parent

get parent(): any
set parent(o): void

Parameters

ParameterType
oany

Returns

any

Inherited from

SheetComponent.parent

Defined in

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


printable

get printable(): boolean

Returns

boolean

Inherited from

SheetComponent.printable

Defined in

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


scaleX

get scaleX(): number
set scaleX(scaleX): void

Parameters

ParameterType
scaleXnumber

Returns

number

Inherited from

SheetComponent.scaleX

Defined in

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


scaleY

get scaleY(): number
set scaleY(scaleY): void

Parameters

ParameterType
scaleYnumber

Returns

number

Inherited from

SheetComponent.scaleY

Defined in

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


skewX

get skewX(): number
set skewX(skewX): void

Parameters

ParameterType
skewXnumber

Returns

number

Inherited from

SheetComponent.skewX

Defined in

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


skewY

get skewY(): number
set skewY(skewY): void

Parameters

ParameterType
skewYnumber

Returns

number

Inherited from

SheetComponent.skewY

Defined in

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


strokeWidth

get strokeWidth(): number
set strokeWidth(width): void

Parameters

ParameterType
widthnumber

Returns

number

Inherited from

SheetComponent.strokeWidth

Defined in

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


top

get top(): number
set top(num): void

Parameters

ParameterType
numstring | number

Returns

number

Inherited from

SheetComponent.top

Defined in

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


topOrigin

get topOrigin(): string | number

Returns

string | number

Inherited from

SheetComponent.topOrigin

Defined in

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


transform

get transform(): Transform
set transform(trans): void

Parameters

ParameterType
transTransform

Returns

Transform

Inherited from

SheetComponent.transform

Defined in

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


transformerConfig

get transformerConfig(): ITransformerConfig
set transformerConfig(config): void

Parameters

ParameterType
configITransformerConfig

Returns

ITransformerConfig

Inherited from

SheetComponent.transformerConfig

Defined in

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


visible

get visible(): boolean

Returns

boolean

Inherited from

SheetComponent.visible

Defined in

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


width

get width(): number
set width(num): void

Parameters

ParameterType
numstring | number

Returns

number

Inherited from

SheetComponent.width

Defined in

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


widthOrigin

get widthOrigin(): string | number

Returns

string | number

Inherited from

SheetComponent.widthOrigin

Defined in

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


zIndex

get zIndex(): number
set zIndex(index): void

Parameters

ParameterType
indexnumber

Returns

number

Inherited from

SheetComponent.zIndex

Defined in

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

Methods

_applyCache()

protected _applyCache(
   cacheCanvas, 
   ctx, 
   sx, 
   sy, 
   sw, 
   sh, 
   dx, 
   dy, 
   dw, 
   dh): void

applyCache from cache canvas

Parameters

ParameterTypeDefault valueDescription
cacheCanvasCanvasundefinedSource Image
ctxUniverRenderingContextundefinedMainCtx
sxnumber0-
synumber0-
swnumber0-
shnumber0-
dxnumber0-
dynumber0-
dwnumber0-
dhnumber0-

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:425 (opens in a new tab)


_draw()

protected _draw(ctx, bounds?): void

Parameters

ParameterType
ctxUniverRenderingContext
bounds?IViewportInfo

Returns

void

Overrides

SheetComponent._draw

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:468 (opens in a new tab)


_setTransForm()

protected _setTransForm(): void

Returns

void

Inherited from

SheetComponent._setTransForm

Defined in

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


applyTransform()

applyTransform(): void

Returns

void

Inherited from

SheetComponent.applyTransform

Defined in

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


dispose()

dispose(): void

TODO: DR-Univer, fix as unknown as

Returns

void

Overrides

SheetComponent.dispose

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:101 (opens in a new tab)


disposeWithMe()

protected disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

SheetComponent.disposeWithMe

Defined in

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


draw()

draw(ctx, viewportInfo): void

draw by viewport cacheBound ---> viewBound diffCacheBounds ---> diffRange

Parameters

ParameterType
ctxUniverRenderingContext
viewportInfoIViewportInfo

Returns

void

Overrides

SheetComponent.draw

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:120 (opens in a new tab)


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

SheetComponent.ensureNotDisposed

Defined in

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


flip()

flip(flipX?, flipY?): Spreadsheet

Parameters

ParameterType
flipX?boolean
flipY?boolean

Returns

Spreadsheet

Inherited from

SheetComponent.flip

Defined in

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


getDocuments()

getDocuments(): Documents

Returns

Documents

Overrides

SheetComponent.getDocuments

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:86 (opens in a new tab)


getEngine()

getEngine(): any

Returns

any

Inherited from

SheetComponent.getEngine

Defined in

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


getExtensionByKey()

getExtensionByKey(uKey): undefined | ComponentExtension<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]>

Parameters

ParameterType
uKeystring

Returns

undefined | ComponentExtension<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]>

Inherited from

SheetComponent.getExtensionByKey

Defined in

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


getExtensionsByOrder()

getExtensionsByOrder(): ComponentExtension<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]>[]

Returns

ComponentExtension<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]>[]

Inherited from

SheetComponent.getExtensionsByOrder

Defined in

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


getInverseCoord()

getInverseCoord(coord): Vector2

Parameters

ParameterType
coordVector2

Returns

Vector2

Inherited from

SheetComponent.getInverseCoord

Defined in

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


getLayerIndex()

getLayerIndex(): number

Returns

number

Inherited from

SheetComponent.getLayerIndex

Defined in

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


getNoMergeCellPositionByIndex()

getNoMergeCellPositionByIndex(rowIndex, columnIndex): undefined | {
  endX: number;
  endY: number;
  startX: number;
  startY: number;
}

Parameters

ParameterType
rowIndexnumber
columnIndexnumber

Returns

undefined | { endX: number; endY: number; startX: number; startY: number; }

Overrides

SheetComponent.getNoMergeCellPositionByIndex

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:160 (opens in a new tab)


getObjects()

getObjects(): BaseObject[]

Returns

BaseObject[]

Inherited from

SheetComponent.getObjects

Defined in

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


getParent()

getParent(): any

Returns

any

Inherited from

SheetComponent.getParent

Defined in

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


getParentScale()

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

Returns

{
  scaleX: number;
  scaleY: number;
}
NameTypeDefined in
scaleXnumbersubmodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:62 (opens in a new tab)
scaleYnumbersubmodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:63 (opens in a new tab)

Inherited from

SheetComponent.getParentScale

Defined in

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


getScene()

getScene(): any

Returns

any

Inherited from

SheetComponent.getScene

Defined in

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


getScrollXYByRelativeCoords()

getScrollXYByRelativeCoords(coord): {
  x: number;
  y: number;
}

Parameters

ParameterType
coordVector2

Returns

{
  x: number;
  y: number;
}
NameTypeDefined in
xnumbersubmodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:200 (opens in a new tab)
ynumbersubmodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:201 (opens in a new tab)

Overrides

SheetComponent.getScrollXYByRelativeCoords

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:188 (opens in a new tab)


getSelectionBounding()

getSelectionBounding(
   startRow, 
   startColumn, 
   endRow, 
   endColumn): undefined | {
  endColumn: number;
  endRow: number;
  startColumn: number;
  startRow: number;
}

Parameters

ParameterType
startRownumber
startColumnnumber
endRownumber
endColumnnumber

Returns

undefined | { endColumn: number; endRow: number; startColumn: number; startRow: number; }

Overrides

SheetComponent.getSelectionBounding

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:222 (opens in a new tab)


getSkeleton()

getSkeleton(): undefined | SpreadsheetSkeleton

Returns

undefined | SpreadsheetSkeleton

Inherited from

SheetComponent.getSkeleton

Defined in

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


getState()

getState(): ITransformState

Returns

ITransformState

Inherited from

SheetComponent.getState

Defined in

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


hide()

hide(): void

Returns

void

Inherited from

SheetComponent.hide

Defined in

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


isDirty()

isDirty(): boolean

Returns

boolean

Inherited from

SheetComponent.isDirty

Defined in

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


isForceDirty()

isForceDirty(): boolean

Returns

boolean

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:205 (opens in a new tab)


isHit()

isHit(coord): boolean

Parameters

ParameterType
coordVector2

Returns

boolean

Overrides

SheetComponent.isHit

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:147 (opens in a new tab)


isRender()

isRender(bounds?): undefined | boolean

Parameters

ParameterType
bounds?IViewportInfo

Returns

undefined | boolean

Inherited from

SheetComponent.isRender

Defined in

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


makeDirty()

makeDirty(state): Spreadsheet

Since multiple controllers, not just the sheet-render.controller, invoke spreadsheet.makeDirty() — for instance, the cf.render-controller — it's essential to also call viewport.markDirty() whenever spreadsheet.makeDirty() is triggered.

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

Spreadsheet

Overrides

SheetComponent.makeDirty

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:231 (opens in a new tab)


makeDirtyNoDebounce()

makeDirtyNoDebounce(state): Spreadsheet

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

Spreadsheet

Inherited from

SheetComponent.makeDirtyNoDebounce

Defined in

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


makeForceDirty()

makeForceDirty(state): void

canvas resize & zoom would call forceDirty

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

void

Overrides

SheetComponent.makeForceDirty

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:213 (opens in a new tab)


paintNewAreaForScrolling()

paintNewAreaForScrolling(viewportInfo, param): void

Parameters

ParameterType
viewportInfoIViewportInfo
paramIPaintForScrolling

Returns

void

Defined in

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


refreshCacheCanvas()

refreshCacheCanvas(viewportInfo, param): void

Redraw the entire viewport.

Parameters

ParameterType
viewportInfoIViewportInfo
paramIPaintForRefresh

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:330 (opens in a new tab)


register()

register(...extensions): IDisposable

Parameters

ParameterType
...extensionsComponentExtension<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]>[]

Returns

IDisposable

Inherited from

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

SheetComponent.removeTransform

Defined in

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


render()

render(mainCtx, viewportInfo): undefined | Spreadsheet

Parameters

ParameterType
mainCtxUniverRenderingContext
viewportInfoIViewportInfo

Returns

undefined | Spreadsheet

Overrides

SheetComponent.render

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:352 (opens in a new tab)


renderByViewport()

renderByViewport(
   mainCtx, 
   viewportInfo, 
   spreadsheetSkeleton): void

Parameters

ParameterType
mainCtxUniverRenderingContext
viewportInfoIViewportInfo
spreadsheetSkeletonSpreadsheetSkeleton

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:244 (opens in a new tab)


resetCursor()

resetCursor(): void

Returns

void

Inherited from

SheetComponent.resetCursor

Defined in

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


resize()

resize(width?, height?): Spreadsheet

Parameters

ParameterType
width?string | number
height?string | number

Returns

Spreadsheet

Inherited from

SheetComponent.resize

Defined in

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


scale()

scale(scaleX?, scaleY?): Spreadsheet

Parameters

ParameterType
scaleX?number
scaleY?number

Returns

Spreadsheet

Inherited from

SheetComponent.scale

Defined in

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


setCursor()

setCursor(val): void

Parameters

ParameterType
valCURSOR_TYPE

Returns

void

Inherited from

SheetComponent.setCursor

Defined in

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


setDirtyArea()

setDirtyArea(dirtyBounds): void

Parameters

ParameterType
dirtyBoundsIBoundRectNoAngle[]

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:240 (opens in a new tab)


setForceDisableGridlines()

setForceDisableGridlines(disabled): void

Parameters

ParameterType
disabledboolean

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:218 (opens in a new tab)


sheetContentViewport()

sheetContentViewport(): SHEET_VIEWPORT_KEY[]

Returns

SHEET_VIEWPORT_KEY[]

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:702 (opens in a new tab)


sheetHeaderViewport()

sheetHeaderViewport(): SHEET_VIEWPORT_KEY[]

Returns

SHEET_VIEWPORT_KEY[]

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:706 (opens in a new tab)


show()

show(): void

Returns

void

Inherited from

SheetComponent.show

Defined in

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


skew()

skew(skewX?, skewY?): Spreadsheet

Parameters

ParameterType
skewX?number
skewY?number

Returns

Spreadsheet

Inherited from

SheetComponent.skew

Defined in

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


testGetRandomLightColor()

testGetRandomLightColor(): string

Returns

string

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:764 (opens in a new tab)


testShowRuler()

testShowRuler(cacheCtx, viewportInfo): void

Parameters

ParameterType
cacheCtxUniverRenderingContext
viewportInfoIViewportInfo

Returns

void

Defined in

submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:710 (opens in a new tab)


toJson()

toJson(): IKeyValue

Returns

IKeyValue

Inherited from

SheetComponent.toJson

Defined in

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


transformByState()

transformByState(option): undefined | Spreadsheet

Parameters

ParameterType
optionIObjectFullState

Returns

undefined | Spreadsheet

Inherited from

SheetComponent.transformByState

Defined in

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


transformForAngle()

transformForAngle(transform): Transform

Parameters

ParameterType
transformTransform

Returns

Transform

Inherited from

SheetComponent.transformForAngle

Defined in

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


translate()

translate(x?, y?): Spreadsheet

Parameters

ParameterType
x?string | number
y?string | number

Returns

Spreadsheet

Inherited from

SheetComponent.translate

Defined in

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


triggerDblclick()

triggerDblclick(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

SheetComponent.triggerDblclick

Defined in

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


triggerDragEnter()

triggerDragEnter(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IDragEvent

Returns

boolean

Inherited from

SheetComponent.triggerDragEnter

Defined in

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


triggerDragLeave()

triggerDragLeave(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IDragEvent

Returns

boolean

Inherited from

SheetComponent.triggerDragLeave

Defined in

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


triggerDragOver()

triggerDragOver(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IDragEvent

Returns

boolean

Inherited from

SheetComponent.triggerDragOver

Defined in

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


triggerDrop()

triggerDrop(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IDragEvent

Returns

boolean

Inherited from

SheetComponent.triggerDrop

Defined in

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


triggerMouseWheel()

triggerMouseWheel(evt): boolean

Parameters

ParameterType
evtIWheelEvent

Returns

boolean

Inherited from

SheetComponent.triggerMouseWheel

Defined in

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


triggerPointerDown()

triggerPointerDown(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

SheetComponent.triggerPointerDown

Defined in

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


triggerPointerEnter()

triggerPointerEnter(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

SheetComponent.triggerPointerEnter

Defined in

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


triggerPointerLeave()

triggerPointerLeave(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

SheetComponent.triggerPointerLeave

Defined in

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


triggerPointerMove()

triggerPointerMove(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

SheetComponent.triggerPointerMove

Defined in

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


triggerPointerOut()

triggerPointerOut(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

SheetComponent.triggerPointerOut

Defined in

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


triggerPointerOver()

triggerPointerOver(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

SheetComponent.triggerPointerOver

Defined in

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


triggerPointerUp()

triggerPointerUp(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

SheetComponent.triggerPointerUp

Defined in

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


triggerTripleClick()

triggerTripleClick(evt): boolean

Parameters

ParameterType
evtIMouseEvent | IPointerEvent

Returns

boolean

Inherited from

SheetComponent.triggerTripleClick

Defined in

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


updateSkeleton()

updateSkeleton(spreadsheetSkeleton): void

Parameters

ParameterType
spreadsheetSkeletonSpreadsheetSkeleton

Returns

void

Inherited from

SheetComponent.updateSkeleton

Defined in

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


Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.