@univerjs/engine-render v0.5.0-beta.1 • Docs

Class: ColumnHeaderLayout

Column Header Bar, include a lot of columns header

Extends

SheetExtension

Constructors

new ColumnHeaderLayout()

new ColumnHeaderLayout(cfg?): ColumnHeaderLayout

Parameters

Parameter	Type
`cfg`?	`IColumnsHeaderCfgParam`

Returns

ColumnHeaderLayout

Overrides

SheetExtension.constructor

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/extensions/column-header-layout.ts:60

Properties

Property	Type	Default value	Overrides	Inherited from	Defined in
`columnsCfg`	`IAColumnCfg`[]	`[]`	-	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/extensions/column-header-layout.ts:49
`extensionOffset`	`IExtensionConfig`	`{}`	-	`SheetExtension`.`extensionOffset`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/extension.ts:53
`headerStyle`	`IColumnStyleCfg`	`undefined`	-	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/extensions/column-header-layout.ts:50
`parent`	`Nullable`<`BaseObject`>	`undefined`	-	`SheetExtension`.`parent`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/extension.ts:47
`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/column-header-layout.ts:47
`Z_INDEX`	`number`	`10`	`SheetExtension`.`Z_INDEX`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/extensions/column-header-layout.ts:48

Accessors

zIndex

Get Signature

get zIndex(): number

Returns

number

Inherited from

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

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

configHeaderColumn()

configHeaderColumn(cfg): void

Parameters

Parameter	Type
`cfg`	`IColumnsHeaderCfgParam`

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/extensions/column-header-layout.ts:67

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): void

Parameters

Parameter	Type
`ctx`	`UniverRenderingContext`
`parentScale`	`IScale`
`spreadsheetSkeleton`	`SpreadsheetSkeleton`

Returns

void

Overrides

SheetExtension.draw

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/extensions/column-header-layout.ts:99

getCfgOfCurrentColumn()

getCfgOfCurrentColumn(colIndex): [IAColumnCfgObj, boolean]

Parameters

Parameter	Type
`colIndex`	`number`

Returns

[IAColumnCfgObj, boolean]

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/extensions/column-header-layout.ts:72

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

setStyleToCtx()

setStyleToCtx(ctx, columnStyle): void

Parameters

Parameter	Type
`ctx`	`UniverRenderingContext`
`columnStyle`	`Partial`<`IColumnStyleCfg`>

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/extensions/column-header-layout.ts:90

Circle Componentextension