Class: Spreadsheet

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

Extends

SheetComponent

Constructors

new Spreadsheet()

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

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

Parameters

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

Returns

Spreadsheet

Overrides

SheetComponent.constructor

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:96
`_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

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

Returns

boolean

ancestorGroup

Get Signature

get ancestorGroup(): Nullable<BaseObject>

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

Returns

Nullable<BaseObject>

Inherited from

SheetComponent.ancestorGroup

ancestorLeft

Get Signature

get ancestorLeft(): any

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

Returns

any

Inherited from

SheetComponent.ancestorLeft

ancestorScaleX

Get Signature

get ancestorScaleX(): number

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

Returns

number

Inherited from

SheetComponent.ancestorScaleX

ancestorScaleY

Get Signature

get ancestorScaleY(): number

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

Returns

number

Inherited from

SheetComponent.ancestorScaleY

ancestorTop

Get Signature

get ancestorTop(): any

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

Returns

any

Inherited from

SheetComponent.ancestorTop

ancestorTransform

Get Signature

get ancestorTransform(): any

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

Returns

any

Inherited from

SheetComponent.ancestorTransform

angle

Get Signature

get angle(): number

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

Returns

number

Set Signature

set angle(angle): void

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

Parameters

Parameter	Type
`angle`	`number`

Returns

void

Inherited from

SheetComponent.angle

backgroundExtension

Get Signature

get backgroundExtension(): Background

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

Returns

Background

borderExtension

Get Signature

get borderExtension(): Border

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

Returns

Border

classType

Get Signature

get classType(): RENDER_CLASS_TYPE

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

Returns

RENDER_CLASS_TYPE

Inherited from

SheetComponent.classType

cursor

Get Signature

get cursor(): CURSOR_TYPE

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

Returns

CURSOR_TYPE

Set Signature

set cursor(val): void

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

Parameters

Parameter	Type
`val`	`CURSOR_TYPE`

Returns

void

Inherited from

SheetComponent.cursor

debounceParentDirty

Get Signature

get debounceParentDirty(): boolean

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

Returns

boolean

Set Signature

set debounceParentDirty(state): void

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

Parameters

Parameter	Type
`state`	`boolean`

Returns

void

Inherited from

SheetComponent.debounceParentDirty

evented

Get Signature

get evented(): boolean

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

Returns

boolean

Set Signature

set evented(state): void

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

Parameters

Parameter	Type
`state`	`boolean`

Returns

void

Inherited from

SheetComponent.evented

extensions

Get Signature

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

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

Returns

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

Inherited from

SheetComponent.extensions

flipX

Get Signature

get flipX(): boolean

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

Returns

boolean

Set Signature

set flipX(flipX): void

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

Parameters

Parameter	Type
`flipX`	`boolean`

Returns

void

Inherited from

SheetComponent.flipX

flipY

Get Signature

get flipY(): boolean

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

Returns

boolean

Set Signature

set flipY(flipY): void

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

Parameters

Parameter	Type
`flipY`	`boolean`

Returns

void

Inherited from

SheetComponent.flipY

fontExtension

Get Signature

get fontExtension(): Font

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

Returns

Font

forceDisableGridlines

Get Signature

get forceDisableGridlines(): boolean

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

Returns

boolean

height

Get Signature

get height(): number

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

Returns

number

Set Signature

set height(num): void

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

Parameters

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

Returns

void

Inherited from

SheetComponent.height

heightOrigin

Get Signature

get heightOrigin(): string | number

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

Returns

string | number

Inherited from

SheetComponent.heightOrigin

layer

Get Signature

get layer(): Nullable<Layer>

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

Returns

Nullable<Layer>

Set Signature

set layer(layer): void

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

Parameters

Parameter	Type
`layer`	`Layer`

Returns

void

Inherited from

SheetComponent.layer

left

Get Signature

get left(): number

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

Returns

number

Set Signature

set left(num): void

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

Parameters

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

Returns

void

Inherited from

SheetComponent.left

leftOrigin

Get Signature

get leftOrigin(): string | number

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

Returns

string | number

Inherited from

SheetComponent.leftOrigin

maxZIndex

Get Signature

get maxZIndex(): number

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

Returns

number

Inherited from

SheetComponent.maxZIndex

oKey

Get Signature

get oKey(): string

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

Returns

string

Inherited from

SheetComponent.oKey

parent

Get Signature

get parent(): any

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

Returns

any

Set Signature

set parent(o): void

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

Parameters

Parameter	Type
`o`	`any`

Returns

void

Inherited from

SheetComponent.parent

printable

Get Signature

get printable(): boolean

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

Returns

boolean

Inherited from

SheetComponent.printable

scaleX

Get Signature

get scaleX(): number

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

Returns

number

Set Signature

set scaleX(scaleX): void

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

Parameters

Parameter	Type
`scaleX`	`number`

Returns

void

Inherited from

SheetComponent.scaleX

scaleY

Get Signature

get scaleY(): number

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

Returns

number

Set Signature

set scaleY(scaleY): void

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

Parameters

Parameter	Type
`scaleY`	`number`

Returns

void

Inherited from

SheetComponent.scaleY

skewX

Get Signature

get skewX(): number

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

Returns

number

Set Signature

set skewX(skewX): void

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

Parameters

Parameter	Type
`skewX`	`number`

Returns

void

Inherited from

SheetComponent.skewX

skewY

Get Signature

get skewY(): number

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

Returns

number

Set Signature

set skewY(skewY): void

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

Parameters

Parameter	Type
`skewY`	`number`

Returns

void

Inherited from

SheetComponent.skewY

strokeWidth

Get Signature

get strokeWidth(): number

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

Returns

number

Set Signature

set strokeWidth(width): void

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

Parameters

Parameter	Type
`width`	`number`

Returns

void

Inherited from

SheetComponent.strokeWidth

top

Get Signature

get top(): number

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

Returns

number

Set Signature

set top(num): void

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

Parameters

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

Returns

void

Inherited from

SheetComponent.top

topOrigin

Get Signature

get topOrigin(): string | number

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

Returns

string | number

Inherited from

SheetComponent.topOrigin

transform

Get Signature

get transform(): Transform

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

Returns

Transform

Set Signature

set transform(trans): void

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

Parameters

Parameter	Type
`trans`	`Transform`

Returns

void

Inherited from

SheetComponent.transform

transformerConfig

Get Signature

get transformerConfig(): ITransformerConfig

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

Returns

ITransformerConfig

Set Signature

set transformerConfig(config): void

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

Parameters

Parameter	Type
`config`	`ITransformerConfig`

Returns

void

Inherited from

SheetComponent.transformerConfig

visible

Get Signature

get visible(): boolean

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

Returns

boolean

Inherited from

SheetComponent.visible

width

Get Signature

get width(): number

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

Returns

number

Set Signature

set width(num): void

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

Parameters

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

Returns

void

Inherited from

SheetComponent.width

widthOrigin

Get Signature

get widthOrigin(): string | number

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

Returns

string | number

Inherited from

SheetComponent.widthOrigin

zIndex

Get Signature

get zIndex(): number

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

Returns

number

Set Signature

set zIndex(index): void

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

Parameters

Parameter	Type
`index`	`number`

Returns

void

Inherited from

SheetComponent.zIndex

Methods

_applyCache()

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

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

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

_draw()

protected _draw(ctx, bounds?): void

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

Parameters

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

Returns

void

Overrides

SheetComponent._draw

_setTransForm()

protected _setTransForm(): void

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

Returns

void

Inherited from

SheetComponent._setTransForm

addRenderFrameTimeMetricToScene()

addRenderFrameTimeMetricToScene(
   timeKey, 
   val, 
   scene): void

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

Parameters

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

Returns

void

addRenderTagToScene()

addRenderTagToScene(
   renderKey, 
   val, 
   scene?): void

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

Parameters

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

Returns

void

applyTransform()

applyTransform(): void

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

Returns

void

Inherited from

SheetComponent.applyTransform

dispose()

dispose(): void

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

TODO: DR-Univer, fix as unknown as

Returns

void

Overrides

SheetComponent.dispose

disposeWithMe()

disposeWithMe(disposable): IDisposable

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:99

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

SheetComponent.disposeWithMe

draw()

draw(ctx, viewportInfo): void

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

draw by viewport

Parameters

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

Returns

void

Overrides

SheetComponent.draw

ensureNotDisposed()

protected ensureNotDisposed(): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:103

Returns

void

Inherited from

SheetComponent.ensureNotDisposed

flip()

flip(flipX?, flipY?): Spreadsheet

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

Parameters

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

Returns

Spreadsheet

Inherited from

SheetComponent.flip

getDocuments()

getDocuments(): Documents

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

Returns

Documents

Overrides

SheetComponent.getDocuments

getEngine()

getEngine(): Nullable<Engine>

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

Returns

Nullable<Engine>

Inherited from

SheetComponent.getEngine

getExtensionByKey()

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

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

Parameters

Parameter	Type
`uKey`	`string`

Returns

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

Inherited from

SheetComponent.getExtensionByKey

getExtensionsByOrder()

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

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

Returns

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

Inherited from

SheetComponent.getExtensionsByOrder

getInverseCoord()

getInverseCoord(coord): Vector2

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

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

Vector2

Inherited from

SheetComponent.getInverseCoord

getLayerIndex()

getLayerIndex(): number

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

Returns

number

Inherited from

SheetComponent.getLayerIndex

getNoMergeCellPositionByIndex()

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

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

Parameters

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

Returns

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

Overrides

SheetComponent.getNoMergeCellPositionByIndex

getObjects()

getObjects(): BaseObject[]

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

Returns

BaseObject[]

Inherited from

SheetComponent.getObjects

getParent()

getParent(): any

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

Returns

any

Inherited from

SheetComponent.getParent

getParentScale()

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

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

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

getScene()

getScene(): Scene

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

override for return type as Scene.

Returns

Scene

Scene

Overrides

SheetComponent.getScene

getScrollXYByRelativeCoords()

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

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

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

getSelectionBounding()

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

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

Parameters

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

Returns

undefined | IRange

Overrides

SheetComponent.getSelectionBounding

getSkeleton()

getSkeleton(): undefined | SpreadsheetSkeleton

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

Returns

undefined | SpreadsheetSkeleton

Inherited from

SheetComponent.getSkeleton

getState()

getState(): ITransformState

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

Returns

ITransformState

Inherited from

SheetComponent.getState

hide()

hide(): void

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

Returns

void

Inherited from

SheetComponent.hide

isDirty()

isDirty(): boolean

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

Returns

boolean

Inherited from

SheetComponent.isDirty

isForceDirty()

isForceDirty(): boolean

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

Returns

boolean

isHit()

isHit(coord): boolean

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

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

boolean

Overrides

SheetComponent.isHit

isRender()

isRender(bounds?): undefined | boolean

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

Parameters

Parameter	Type
`bounds`?	`IViewportInfo`

Returns

undefined | boolean

Inherited from

SheetComponent.isRender

makeDirty()

makeDirty(state): Spreadsheet

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

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

makeDirtyNoDebounce()

makeDirtyNoDebounce(state): Spreadsheet

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

Parameters

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

Returns

Spreadsheet

Inherited from

SheetComponent.makeDirtyNoDebounce

makeForceDirty()

makeForceDirty(state): void

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

canvas resize & zoom would call forceDirty

Parameters

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

Returns

void

Overrides

SheetComponent.makeForceDirty

paintNewAreaForScrolling()

paintNewAreaForScrolling(viewportInfo, param): void

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

Parameters

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

Returns

void

refreshCacheCanvas()

refreshCacheCanvas(viewportInfo, param): void

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

Redraw the entire viewport.

Parameters

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

Returns

void

register()

register(...extensions): IDisposable

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

Parameters

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

Returns

IDisposable

Inherited from

SheetComponent.register

removeTransform()

removeTransform(): void

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

Returns

void

Inherited from

SheetComponent.removeTransform

render()

render(mainCtx, viewportInfo): undefined | Spreadsheet

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

Parameters

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

Returns

undefined | Spreadsheet

Overrides

SheetComponent.render

renderByViewports()

renderByViewports(
   mainCtx, 
   viewportInfo, 
   spreadsheetSkeleton): void

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

Parameters

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

Returns

void

resetCursor()

resetCursor(): void

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

Returns

void

Inherited from

SheetComponent.resetCursor

resize()

resize(width?, height?): Spreadsheet

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

Parameters

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

Returns

Spreadsheet

Inherited from

SheetComponent.resize

scale()

scale(scaleX?, scaleY?): Spreadsheet

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

Parameters

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

Returns

Spreadsheet

Inherited from

SheetComponent.scale

setCursor()

setCursor(val): void

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

Parameters

Parameter	Type
`val`	`CURSOR_TYPE`

Returns

void

Inherited from

SheetComponent.setCursor

setDirtyArea()

setDirtyArea(dirtyBounds): void

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

Parameters

Parameter	Type
`dirtyBounds`	`IBoundRectNoAngle`[]

Returns

void

setForceDisableGridlines()

setForceDisableGridlines(disabled): void

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

Parameters

Parameter	Type
`disabled`	`boolean`

Returns

void

show()

show(): void

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

Returns

void

Inherited from

SheetComponent.show

skew()

skew(skewX?, skewY?): Spreadsheet

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

Parameters

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

Returns

Spreadsheet

Inherited from

SheetComponent.skew

testGetRandomLightColor()

testGetRandomLightColor(): string

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

Returns

string

testShowRuler()

testShowRuler(cacheCtx, viewportInfo): void

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

Parameters

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

Returns

void

toJson()

toJson(): IKeyValue

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

Returns

IKeyValue

Inherited from

SheetComponent.toJson

transformByState()

transformByState(option): undefined | Spreadsheet

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

this[pKey] = option[pKey]

Parameters

Parameter	Type
`option`	`IObjectFullState`

Returns

undefined | Spreadsheet

Inherited from

SheetComponent.transformByState

transformForAngle()

transformForAngle(transform): Transform

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

Parameters

Parameter	Type
`transform`	`Transform`

Returns

Transform

Inherited from

SheetComponent.transformForAngle

translate()

translate(x?, y?): Spreadsheet

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

Parameters

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

Returns

Spreadsheet

Inherited from

SheetComponent.translate

triggerDblclick()

triggerDblclick(evt): boolean

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

Parameters

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

Returns

boolean

Inherited from

SheetComponent.triggerDblclick

triggerDragEnter()

triggerDragEnter(evt): boolean

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

Parameters

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

Returns

boolean

Inherited from

SheetComponent.triggerDragEnter

triggerDragLeave()

triggerDragLeave(evt): boolean

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

Parameters

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

Returns

boolean

Inherited from

SheetComponent.triggerDragLeave

triggerDragOver()

triggerDragOver(evt): boolean

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

Parameters

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

Returns

boolean

Inherited from

SheetComponent.triggerDragOver

triggerDrop()

triggerDrop(evt): boolean

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

Parameters

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

Returns

boolean

Inherited from

SheetComponent.triggerDrop

triggerMouseWheel()

triggerMouseWheel(evt): boolean

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

Parameters

Parameter	Type
`evt`	`IWheelEvent`

Returns

boolean

Inherited from

SheetComponent.triggerMouseWheel

triggerPointerCancel()

triggerPointerCancel(evt): boolean

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

Parameters

Parameter	Type
`evt`	`IPointerEvent`

Returns

boolean

Inherited from

SheetComponent.triggerPointerCancel

triggerPointerDown()

triggerPointerDown(evt): boolean

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

Parameters

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

Returns

boolean

Inherited from

SheetComponent.triggerPointerDown

triggerPointerEnter()

triggerPointerEnter(evt): boolean

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

Parameters

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

Returns

boolean

Inherited from

SheetComponent.triggerPointerEnter

triggerPointerLeave()

triggerPointerLeave(evt): boolean

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

Parameters

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

Returns

boolean

Inherited from

SheetComponent.triggerPointerLeave

triggerPointerMove()

triggerPointerMove(evt): boolean

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

Parameters

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

Returns

boolean

Inherited from

SheetComponent.triggerPointerMove

triggerPointerOut()

triggerPointerOut(evt): boolean

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

Parameters

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

Returns

boolean

Inherited from

SheetComponent.triggerPointerOut

triggerPointerOver()

triggerPointerOver(evt): boolean

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

Parameters

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

Returns

boolean

Inherited from

SheetComponent.triggerPointerOver

triggerPointerUp()

triggerPointerUp(evt): boolean

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

Parameters

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

Returns

boolean

Inherited from

SheetComponent.triggerPointerUp

triggerTripleClick()

triggerTripleClick(evt): boolean

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

Parameters

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

Returns

boolean

Inherited from

SheetComponent.triggerTripleClick

updateSkeleton()

updateSkeleton(spreadsheetSkeleton): void

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

Parameters

Parameter	Type
`spreadsheetSkeleton`	`SpreadsheetSkeleton`

Returns

void

Inherited from

SheetComponent.updateSkeleton

Slide Spreadsheetcolumnheader