Class: ColumnHeaderLayout

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

Column Header Bar, include a lot of columns header

Extends

SheetExtension

Constructors

new ColumnHeaderLayout()

new ColumnHeaderLayout(cfg?): ColumnHeaderLayout

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

Parameters

Parameter	Type
`cfg`?	`IColumnsHeaderCfgParam`

Returns

ColumnHeaderLayout

Overrides

SheetExtension.constructor

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`	`GRID`	`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

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

Returns

number

Inherited from

SheetExtension.zIndex

Methods

_getScale()

protected _getScale(parentScale): number

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

Parameters

Parameter	Type
`parentScale`	`IScale`

Returns

number

Inherited from

SheetExtension._getScale

clearCache()

clearCache(): void

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

Returns

void

Inherited from

SheetExtension.clearCache

configHeaderColumn()

configHeaderColumn(cfg): void

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

Parameters

Parameter	Type
`cfg`	`IColumnsHeaderCfgParam`

Returns

void

dispose()

dispose(): void

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

Returns

void

Inherited from

SheetExtension.dispose

draw()

draw(
   ctx, 
   parentScale, 
   spreadsheetSkeleton): void

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

Parameters

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

Returns

void

Overrides

SheetExtension.draw

getCfgOfCurrentColumn()

getCfgOfCurrentColumn(colIndex): [IAColumnCfgObj, boolean]

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

Parameters

Parameter	Type
`colIndex`	`number`

Returns

[IAColumnCfgObj, boolean]

isRenderDiffRangesByCell()

isRenderDiffRangesByCell(rangeP, diffRanges?): boolean

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

Parameters

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

Returns

boolean

Inherited from

SheetExtension.isRenderDiffRangesByCell

isRenderDiffRangesByColumn()

isRenderDiffRangesByColumn(
   curStartColumn, 
   curEndColumn, 
   diffRanges?): boolean

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

Parameters

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

Returns

boolean

Inherited from

SheetExtension.isRenderDiffRangesByColumn

isRenderDiffRangesByRow()

isRenderDiffRangesByRow(
   curStartRow, 
   curEndRow, 
   diffRanges?): boolean

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

Parameters

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

Returns

boolean

Inherited from

SheetExtension.isRenderDiffRangesByRow

isRowInRanges()

isRowInRanges(
   curStartRow, 
   curEndRow, 
   viewranges?): boolean

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

Check if row range is in view ranges

Parameters

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

Returns

boolean

Inherited from

SheetExtension.isRowInRanges

setStyleToCtx()

setStyleToCtx(ctx, columnStyle): void

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

Parameters

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

Returns

void

Circle Componentextension