@univerjs/engine-render v0.5.0-beta.1 • 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
`extensionOffset`	`IExtensionConfig`	`{}`	-	`SheetExtension`.`extensionOffset`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/extension.ts:53
`parent`	`Nullable`<`BaseObject`>	`undefined`	-	`SheetExtension`.`parent`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/extension.ts:47
`PRINTING_Z_INDEX`	`number`	`PRINTING_Z_INDEX`	-	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/extensions/background.ts:54
`translateX`	`number`	`0`	-	`SheetExtension`.`translateX`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/extension.ts:49
`translateY`	`number`	`0`	-	`SheetExtension`.`translateY`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/extension.ts:51
`type`	`SHEET_EXTENSION_TYPE`	`SHEET_EXTENSION_TYPE.GRID`	-	`SheetExtension`.`type`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/extensions/sheet-extension.ts:33
`uKey`	`string`	`UNIQUE_KEY`	`SheetExtension`.`uKey`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/extensions/background.ts:50
`Z_INDEX`	`number`	`DOC_EXTENSION_Z_INDEX`	`SheetExtension`.`Z_INDEX`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/extensions/background.ts:52

Accessors

zIndex

Get Signature

get zIndex(): number

Returns

number

Overrides

SheetExtension.zIndex

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/extensions/background.ts:56

Methods

_getScale()

protected _getScale(parentScale): number

Parameters

Parameter	Type
`parentScale`	`IScale`

Returns

number

Inherited from

SheetExtension._getScale

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/extension.ts:67

clearCache()

clearCache(): void

Returns

void

Inherited from

SheetExtension.clearCache

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/extension.ts:63

dispose()

dispose(): void

Returns

void

Inherited from

SheetExtension.dispose

Defined in

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

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

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

isRenderDiffRangesByCell()

isRenderDiffRangesByCell(rangeP, diffRanges?): boolean

Parameters

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

Returns

boolean

Inherited from

SheetExtension.isRenderDiffRangesByCell

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/extensions/sheet-extension.ts:35

isRenderDiffRangesByColumn()

isRenderDiffRangesByColumn(
   curStartColumn, 
   curEndColumn, 
   diffRanges?): boolean

Parameters

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

Returns

boolean

Inherited from

SheetExtension.isRenderDiffRangesByColumn

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/extensions/sheet-extension.ts:72

isRenderDiffRangesByRow()

isRenderDiffRangesByRow(
   curStartRow, 
   curEndRow, 
   diffRanges?): boolean

Parameters

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

Returns

boolean

Inherited from

SheetExtension.isRenderDiffRangesByRow

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/extensions/sheet-extension.ts:105

isRowInRanges()

isRowInRanges(
   curStartRow, 
   curEndRow, 
   viewranges?): boolean

Check if row range is in view ranges

Parameters

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

Returns

boolean

Inherited from

SheetExtension.isRowInRanges

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/extensions/sheet-extension.ts:144

renderBGByCell()

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

Parameters

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

Returns

undefined | true

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/extensions/background.ts:170

Readme Baseobject