@univerjs/engine-render v0.1.17 • Docs

Class: SheetExtension

Extends

ComponentExtension<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]>

Extended by

Constructors

new SheetExtension()

new SheetExtension(): SheetExtension

Returns

SheetExtension

Inherited from

ComponentExtension.constructor

Properties

Property	Modifier	Type	Default value	Overrides	Inherited from	Defined in
`Z_INDEX`	`protected`	`number`	`0`	-	`ComponentExtension`.`Z_INDEX`	submodules/univer/packages/engine-render/src/components/extension.ts:44 (opens in a new tab)
`extensionOffset`	`public`	`IExtensionConfig`	`{}`	-	`ComponentExtension`.`extensionOffset`	submodules/univer/packages/engine-render/src/components/extension.ts:52 (opens in a new tab)
`parent`	`public`	`Nullable`<`BaseObject`>	`undefined`	-	`ComponentExtension`.`parent`	submodules/univer/packages/engine-render/src/components/extension.ts:46 (opens in a new tab)
`translateX`	`public`	`number`	`0`	-	`ComponentExtension`.`translateX`	submodules/univer/packages/engine-render/src/components/extension.ts:48 (opens in a new tab)
`translateY`	`public`	`number`	`0`	-	`ComponentExtension`.`translateY`	submodules/univer/packages/engine-render/src/components/extension.ts:50 (opens in a new tab)
`type`	`public`	`SHEET_EXTENSION_TYPE`	`SHEET_EXTENSION_TYPE.GRID`	`ComponentExtension`.`type`	-	submodules/univer/packages/engine-render/src/components/sheets/extensions/sheet-extension.ts:28 (opens in a new tab)
`uKey`	`public`	`string`	`''`	-	`ComponentExtension`.`uKey`	submodules/univer/packages/engine-render/src/components/extension.ts:40 (opens in a new tab)

Accessors

zIndex

get zIndex(): number

Returns

number

Inherited from

ComponentExtension.zIndex

Defined in

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

Methods

_getScale()

protected _getScale(parentScale): number

Parameters

Parameter	Type
`parentScale`	`IScale`

Returns

number

Inherited from

ComponentExtension._getScale

Defined in

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

clearCache()

clearCache(): void

Returns

void

Inherited from

ComponentExtension.clearCache

Defined in

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

dispose()

dispose(): void

Returns

void

Inherited from

ComponentExtension.dispose

Defined in

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

draw()

draw(
   ctx, 
   parentScale, 
   skeleton, 
   diffBounds?, 
   more?): void

Parameters

Parameter	Type
`ctx`	`UniverRenderingContext`
`parentScale`	`IScale`
`skeleton`	`SpreadsheetSkeleton`
`diffBounds`?	`IRange`[]
`more`?	`IDrawInfo`

Returns

void

Inherited from

ComponentExtension.draw

Defined in

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

getCellIndex()

getCellIndex(
   rowIndex, 
   columnIndex, 
   rowHeightAccumulation, 
   columnWidthAccumulation, 
   dataMergeCache): ISelectionCellWithCoord

Parameters

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

Returns

ISelectionCellWithCoord

Defined in

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

isRenderDiffRangesByCell()

isRenderDiffRangesByCell(rangeP, diffRanges?): boolean

Parameters

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

Returns

boolean

Defined in

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

isRenderDiffRangesByColumn()

isRenderDiffRangesByColumn(
   curStartColumn, 
   curEndColumn, 
   diffRanges?): boolean

Parameters

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

Returns

boolean

Defined in

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

isRenderDiffRangesByRow()

isRenderDiffRangesByRow(
   curStartRow, 
   curEndRow, 
   diffRanges?): boolean

Parameters

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

Returns

boolean

Defined in

submodules/univer/packages/engine-render/src/components/sheets/extensions/sheet-extension.ts:110 (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

Defined in

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

Sheetcomponent Skeleton