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

Accessors

zIndex

Get Signature

get zIndex(): number

Returns

number

Inherited from

ComponentExtension.zIndex

Defined in

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

Methods

_getScale()

protected _getScale(parentScale): number

Parameters

Parameter	Type
`parentScale`	`IScale`

Returns

number

Inherited from

ComponentExtension._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

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

ComponentExtension.dispose

Defined in

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

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

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

isRenderDiffRangesByCell()

isRenderDiffRangesByCell(rangeP, diffRanges?): boolean

Parameters

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

Returns

boolean

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

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

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

Defined in

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

Sheetcomponent Skeleton