@univerjs/engine-render v0.4.2 • Docs

Class: Background

Extends

SheetExtension

Constructors

new Background()

new Background(): Background

Returns

Background

Inherited from

SheetExtension.constructor

Properties

Property	Type	Default value	Overrides	Inherited from	Defined in
`PRINTING_Z_INDEX`	`number`	`PRINTING_Z_INDEX`	-	-	submodules/univer/packages/engine-render/src/components/sheets/extensions/background.ts:54 (opens in a new tab)
`Z_INDEX`	`number`	`DOC_EXTENSION_Z_INDEX`	`SheetExtension`.`Z_INDEX`	-	submodules/univer/packages/engine-render/src/components/sheets/extensions/background.ts:52 (opens in a new tab)
`extensionOffset`	`IExtensionConfig`	`{}`	-	`SheetExtension`.`extensionOffset`	submodules/univer/packages/engine-render/src/components/extension.ts:53 (opens in a new tab)
`parent`	`Nullable`<`BaseObject`>	`undefined`	-	`SheetExtension`.`parent`	submodules/univer/packages/engine-render/src/components/extension.ts:47 (opens in a new tab)
`translateX`	`number`	`0`	-	`SheetExtension`.`translateX`	submodules/univer/packages/engine-render/src/components/extension.ts:49 (opens in a new tab)
`translateY`	`number`	`0`	-	`SheetExtension`.`translateY`	submodules/univer/packages/engine-render/src/components/extension.ts:51 (opens in a new tab)
`type`	`SHEET_EXTENSION_TYPE`	`SHEET_EXTENSION_TYPE.GRID`	-	`SheetExtension`.`type`	submodules/univer/packages/engine-render/src/components/sheets/extensions/sheet-extension.ts:34 (opens in a new tab)
`uKey`	`string`	`UNIQUE_KEY`	`SheetExtension`.`uKey`	-	submodules/univer/packages/engine-render/src/components/sheets/extensions/background.ts:50 (opens in a new tab)

Accessors

zIndex

get zIndex(): number

Returns

number

Overrides

SheetExtension.zIndex

Defined in

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

Methods

_getScale()

protected _getScale(parentScale): number

Parameters

Parameter	Type
`parentScale`	`IScale`

Returns

number

Inherited from

SheetExtension._getScale

Defined in

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

clearCache()

clearCache(): void

Returns

void

Inherited from

SheetExtension.clearCache

Defined in

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

dispose()

dispose(): void

Returns

void

Inherited from

SheetExtension.dispose

Defined in

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

draw()

draw(
   ctx, 
   _parentScale, 
   spreadsheetSkeleton, 
   diffRanges, 
   __namedParameters): void

Parameters

Parameter	Type
`ctx`	`UniverRenderingContext`
`_parentScale`	`IScale`
`spreadsheetSkeleton`	`SpreadsheetSkeleton`
`diffRanges`	`IRange`[]
`__namedParameters`	`IDrawInfo`

Returns

void

Overrides

SheetExtension.draw

Defined in

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

getCellByIndex()

getCellByIndex(
   rowIndex, 
   columnIndex, 
   rowHeightAccumulation, 
   columnWidthAccumulation, 
   dataMergeCache): ISelectionCellWithMergeInfo

Parameters

Parameter	Type
`rowIndex`	`number`
`columnIndex`	`number`
`rowHeightAccumulation`	`number`[]
`columnWidthAccumulation`	`number`[]
`dataMergeCache`	`IRange`[]

Returns

ISelectionCellWithMergeInfo

cell Position & mergeInfo

Deprecated

The function maybe cause performance issue, use spreadsheetSkeleton.getCellByIndexWithNoHeader instead. Get ISelectionCellWithMergeInfo by cell rowIndex and cell columnIndex. The startXY in return value does not include rowHeader and columnHeader.

Inherited from

SheetExtension.getCellByIndex

Defined in

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

isRenderDiffRangesByCell()

isRenderDiffRangesByCell(rangeP, diffRanges?): boolean

Parameters

Parameter	Type
`rangeP`	`IRange`
`diffRanges`?	`IRange`[]

Returns

boolean

Inherited from

SheetExtension.isRenderDiffRangesByCell

Defined in

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

isRenderDiffRangesByColumn()

isRenderDiffRangesByColumn(
   curStartColumn, 
   curEndColumn, 
   diffRanges?): boolean

Parameters

Parameter	Type
`curStartColumn`	`number`
`curEndColumn`	`number`
`diffRanges`?	`IRange`[]

Returns

boolean

Inherited from

SheetExtension.isRenderDiffRangesByColumn

Defined in

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

isRenderDiffRangesByRow()

isRenderDiffRangesByRow(
   curStartRow, 
   curEndRow, 
   diffRanges?): boolean

Parameters

Parameter	Type
`curStartRow`	`number`
`curEndRow`	`number`
`diffRanges`?	`IRange`[]

Returns

boolean

Inherited from

SheetExtension.isRenderDiffRangesByRow

Defined in

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

isRowInRanges()

isRowInRanges(
   curStartRow, 
   curEndRow, 
   viewranges?): boolean

传入的 row 范围和 diffRanges 有相交, 返回 true

Parameters

Parameter	Type
`curStartRow`	`number`
`curEndRow`	`number`
`viewranges`?	`IRange`[]

Returns

boolean

Inherited from

SheetExtension.isRowInRanges

Defined in

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

renderBGByCell()

renderBGByCell(
   bgContext, 
   row, 
   col): undefined | true

Parameters

Parameter	Type
`bgContext`	`IRenderBGContext`
`row`	`number`
`col`	`number`

Returns

undefined | true

Defined in

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

Readme Baseobject