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

Class: Spreadsheet

Extends

SheetComponent

Constructors

new Spreadsheet()

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

Parameters

Parameter	Type	Default value
`oKey`	`string`	`undefined`
`spreadsheetSkeleton`?	`SpreadsheetSkeleton`	`undefined`
`_allowCache`?	`boolean`	`true`

Returns

Spreadsheet

Overrides

SheetComponent.constructor

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:61

Properties

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

Accessors

allowCache

Get Signature

get allowCache(): boolean

Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:87

ancestorGroup

Get Signature

get ancestorGroup(): Nullable<BaseObject>

Returns

Nullable<BaseObject>

Inherited from

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

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

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

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

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

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

SheetComponent.angle

Defined in

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

backgroundExtension

Get Signature

get backgroundExtension(): Background

Returns

Background

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:71

borderExtension

Get Signature

get borderExtension(): Border

Returns

Border

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:75

classType

Get Signature

get classType(): RENDER_CLASS_TYPE

Returns

RENDER_CLASS_TYPE

Inherited from

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

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

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

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

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

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

SheetComponent.flipY

Defined in

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

fontExtension

Get Signature

get fontExtension(): Font

Returns

Font

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:79

forceDisableGridlines

Get Signature

get forceDisableGridlines(): boolean

Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:91

height

Get Signature

get height(): number

Returns

number

Set Signature

set height(num): void

Parameters

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

Returns

void

Inherited from

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

SheetComponent.zIndex

Defined in

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

Methods

_applyCache()

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

applyCache from cache canvas

Parameters

Parameter	Type	Default value	Description
`cacheCanvas`	`Canvas`	`undefined`	Source Image
`ctx`	`UniverRenderingContext2D`	`undefined`	MainCtx
`sx`	`number`	`0`	-
`sy`	`number`	`0`	-
`sw`	`number`	`0`	-
`sh`	`number`	`0`	-
`dx`	`number`	`0`	-
`dy`	`number`	`0`	-
`dw`	`number`	`0`	-
`dh`	`number`	`0`	-

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:447

_draw()

protected _draw(ctx, bounds?): void

Parameters

Parameter	Type
`ctx`	`UniverRenderingContext2D`
`bounds`?	`IViewportInfo`

Returns

void

Overrides

SheetComponent._draw

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:490

_setTransForm()

protected _setTransForm(): void

Returns

void

Inherited from

SheetComponent._setTransForm

Defined in

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

addRenderFrameTimeMetricToScene()

addRenderFrameTimeMetricToScene(
   timeKey, 
   val, 
   scene): void

Parameters

Parameter	Type
`timeKey`	`string`
`val`	`number`
`scene`	`Scene`

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:141

addRenderTagToScene()

addRenderTagToScene(
   renderKey, 
   val, 
   scene?): void

Parameters

Parameter	Type
`renderKey`	`string`
`val`	`any`
`scene`?	`Scene`

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:148

applyTransform()

applyTransform(): void

Returns

void

Inherited from

SheetComponent.applyTransform

Defined in

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

dispose()

dispose(): void

TODO: DR-Univer, fix as unknown as

Returns

void

Overrides

SheetComponent.dispose

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:95

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

SheetComponent.disposeWithMe

Defined in

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

draw()

draw(ctx, viewportInfo): void

draw by viewport

Parameters

Parameter	Type
`ctx`	`UniverRenderingContext2D`
`viewportInfo`	`IViewportInfo`

Returns

void

Overrides

SheetComponent.draw

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:111

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

SheetComponent.ensureNotDisposed

Defined in

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

flip()

flip(flipX?, flipY?): Spreadsheet

Parameters

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

Returns

Spreadsheet

Inherited from

SheetComponent.flip

Defined in

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

getDocuments()

getDocuments(): Documents

Returns

Documents

Overrides

SheetComponent.getDocuments

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:83

getEngine()

getEngine(): Nullable<Engine>

Returns

Nullable<Engine>

Inherited from

SheetComponent.getEngine

Defined in

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

getExtensionByKey()

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

Parameters

Parameter	Type
`uKey`	`string`

Returns

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

Inherited from

SheetComponent.getExtensionByKey

Defined in

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

getExtensionsByOrder()

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

Returns

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

Inherited from

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

Returns

Vector2

Inherited from

SheetComponent.getInverseCoord

Defined in

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

getLayerIndex()

getLayerIndex(): number

Returns

number

Inherited from

SheetComponent.getLayerIndex

Defined in

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

getNoMergeCellPositionByIndex()

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

Parameters

Parameter	Type
`rowIndex`	`number`
`columnIndex`	`number`

Returns

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

Overrides

SheetComponent.getNoMergeCellPositionByIndex

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:176

getObjects()

getObjects(): BaseObject[]

Returns

BaseObject[]

Inherited from

SheetComponent.getObjects

Defined in

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

getParent()

getParent(): any

Returns

any

Inherited from

SheetComponent.getParent

Defined in

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

getParentScale()

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

Returns

{
  scaleX: number;
  scaleY: number;
}

Name	Type	Defined in
`scaleX`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:63
`scaleY`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:64

Inherited from

SheetComponent.getParentScale

Defined in

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

getScene()

getScene(): Scene

override for return type as Scene.

Returns

Scene

Scene

Overrides

SheetComponent.getScene

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:159

getScrollXYByRelativeCoords()

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

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

{
  x: number;
  y: number;
}

Name	Type	Defined in
`x`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:216
`y`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:217

Overrides

SheetComponent.getScrollXYByRelativeCoords

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:204

getSelectionBounding()

getSelectionBounding(
   startRow, 
   startColumn, 
   endRow, 
   endColumn): undefined | IRange

Parameters

Parameter	Type
`startRow`	`number`
`startColumn`	`number`
`endRow`	`number`
`endColumn`	`number`

Returns

undefined | IRange

Overrides

SheetComponent.getSelectionBounding

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:238

getSkeleton()

getSkeleton(): undefined | SpreadsheetSkeleton

Returns

undefined | SpreadsheetSkeleton

Inherited from

SheetComponent.getSkeleton

Defined in

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

getState()

getState(): ITransformState

Returns

ITransformState

Inherited from

SheetComponent.getState

Defined in

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

hide()

hide(): void

Returns

void

Inherited from

SheetComponent.hide

Defined in

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

isDirty()

isDirty(): boolean

Returns

boolean

Inherited from

SheetComponent.isDirty

Defined in

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

isForceDirty()

isForceDirty(): boolean

Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:221

isHit()

isHit(coord): boolean

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

boolean

Overrides

SheetComponent.isHit

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:163

isRender()

isRender(bounds?): undefined | boolean

Parameters

Parameter	Type
`bounds`?	`IViewportInfo`

Returns

undefined | boolean

Inherited from

SheetComponent.isRender

Defined in

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

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

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

Returns

Spreadsheet

Overrides

SheetComponent.makeDirty

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:246

makeDirtyNoDebounce()

makeDirtyNoDebounce(state): Spreadsheet

Parameters

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

Returns

Spreadsheet

Inherited from

SheetComponent.makeDirtyNoDebounce

Defined in

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

makeForceDirty()

makeForceDirty(state): void

canvas resize & zoom would call forceDirty

Parameters

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

Returns

void

Overrides

SheetComponent.makeForceDirty

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:229

paintNewAreaForScrolling()

paintNewAreaForScrolling(viewportInfo, param): void

Parameters

Parameter	Type
`viewportInfo`	`IViewportInfo`
`param`	`IPaintForScrolling`

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:292

refreshCacheCanvas()

refreshCacheCanvas(viewportInfo, param): void

Redraw the entire viewport.

Parameters

Parameter	Type
`viewportInfo`	`IViewportInfo`
`param`	`IPaintForRefresh`

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:347

register()

register(...extensions): IDisposable

Parameters

Parameter	Type
…`extensions`	`ComponentExtension`<`SpreadsheetSkeleton`, `SHEET_EXTENSION_TYPE`, `IRange`[]>[]

Returns

IDisposable

Inherited from

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

SheetComponent.removeTransform

Defined in

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

render()

render(mainCtx, viewportInfo): undefined | Spreadsheet

Parameters

Parameter	Type
`mainCtx`	`UniverRenderingContext2D`
`viewportInfo`	`IViewportInfo`

Returns

undefined | Spreadsheet

Overrides

SheetComponent.render

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:368

renderByViewport()

renderByViewport(
   mainCtx, 
   viewportInfo, 
   spreadsheetSkeleton): void

Parameters

Parameter	Type
`mainCtx`	`UniverRenderingContext2D`
`viewportInfo`	`IViewportInfo`
`spreadsheetSkeleton`	`SpreadsheetSkeleton`

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:259

resetCursor()

resetCursor(): void

Returns

void

Inherited from

SheetComponent.resetCursor

Defined in

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

resize()

resize(width?, height?): Spreadsheet

Parameters

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

Returns

Spreadsheet

Inherited from

SheetComponent.resize

Defined in

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

scale()

scale(scaleX?, scaleY?): Spreadsheet

Parameters

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

Returns

Spreadsheet

Inherited from

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

SheetComponent.setCursor

Defined in

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

setDirtyArea()

setDirtyArea(dirtyBounds): void

Parameters

Parameter	Type
`dirtyBounds`	`IBoundRectNoAngle`[]

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:255

setForceDisableGridlines()

setForceDisableGridlines(disabled): void

Parameters

Parameter	Type
`disabled`	`boolean`

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:234

show()

show(): void

Returns

void

Inherited from

SheetComponent.show

Defined in

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

skew()

skew(skewX?, skewY?): Spreadsheet

Parameters

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

Returns

Spreadsheet

Inherited from

SheetComponent.skew

Defined in

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

testGetRandomLightColor()

testGetRandomLightColor(): string

Returns

string

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:745

testShowRuler()

testShowRuler(cacheCtx, viewportInfo): void

Parameters

Parameter	Type
`cacheCtx`	`UniverRenderingContext2D`
`viewportInfo`	`IViewportInfo`

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/spreadsheet.ts:691

toJson()

toJson(): IKeyValue

Returns

IKeyValue

Inherited from

SheetComponent.toJson

Defined in

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

transformByState()

transformByState(option): undefined | Spreadsheet

this[pKey] = option[pKey]

Parameters

Parameter	Type
`option`	`IObjectFullState`

Returns

undefined | Spreadsheet

Inherited from

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

SheetComponent.transformForAngle

Defined in

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

translate()

translate(x?, y?): Spreadsheet

Parameters

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

Returns

Spreadsheet

Inherited from

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

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

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

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

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

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

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

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

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

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

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

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

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

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

SheetComponent.triggerTripleClick

Defined in

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

updateSkeleton()

updateSkeleton(spreadsheetSkeleton): void

Parameters

Parameter	Type
`spreadsheetSkeleton`	`SpreadsheetSkeleton`

Returns

void

Inherited from

SheetComponent.updateSkeleton

Defined in

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

Slide Spreadsheetcolumnheader