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

Class: SpreadsheetRowHeader

Extends

SpreadsheetHeader

Constructors

new SpreadsheetRowHeader()

new SpreadsheetRowHeader(oKey, spreadsheetSkeleton?): SpreadsheetRowHeader

Parameters

Parameter	Type
`oKey`	`string`
`spreadsheetSkeleton`?	`SpreadsheetSkeleton`

Returns

SpreadsheetRowHeader

Overrides

SpreadsheetHeader.constructor

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/row-header.ts:40

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_dirty`	`protected`	`boolean`	`true`	`SpreadsheetHeader`.`_dirty`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:88
`_disposed`	`protected`	`boolean`	`false`	`SpreadsheetHeader`.`_disposed`	packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:93
`_forceDirty`	`protected`	`boolean`	`true`	`SpreadsheetHeader`.`_forceDirty`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:89
`_oKey`	`protected`	`string`	`undefined`	`SpreadsheetHeader`.`_oKey`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:86
`groupKey?`	`public`	`string`	`undefined`	`SpreadsheetHeader`.`groupKey`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:59
`isInGroup`	`public`	`boolean`	`false`	`SpreadsheetHeader`.`isInGroup`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:60
`objectType`	`public`	`ObjectType`	`ObjectType.UNKNOWN`	`SpreadsheetHeader`.`objectType`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:62
`onDblclick$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`SpreadsheetHeader`.`onDblclick$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:74
`onDispose$`	`public`	`EventSubject`<`BaseObject`>	`undefined`	`SpreadsheetHeader`.`onDispose$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:84
`onDragEnter$`	`public`	`EventSubject`<`IMouseEvent` \| `IDragEvent`>	`undefined`	`SpreadsheetHeader`.`onDragEnter$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:80
`onDragLeave$`	`public`	`EventSubject`<`IMouseEvent` \| `IDragEvent`>	`undefined`	`SpreadsheetHeader`.`onDragLeave$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:78
`onDragOver$`	`public`	`EventSubject`<`IMouseEvent` \| `IDragEvent`>	`undefined`	`SpreadsheetHeader`.`onDragOver$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:79
`onDrop$`	`public`	`EventSubject`<`IMouseEvent` \| `IDragEvent`>	`undefined`	`SpreadsheetHeader`.`onDrop$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:81
`onIsAddedToParent$`	`public`	`EventSubject`<`any`>	`undefined`	`SpreadsheetHeader`.`onIsAddedToParent$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:83
`onMouseWheel$`	`public`	`EventSubject`<`IWheelEvent`>	`undefined`	`SpreadsheetHeader`.`onMouseWheel$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:76
`onPointerDown$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`SpreadsheetHeader`.`onPointerDown$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:66
`onPointerEnter$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`SpreadsheetHeader`.`onPointerEnter$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:72
`onPointerLeave$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`SpreadsheetHeader`.`onPointerLeave$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:71
`onPointerMove$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`SpreadsheetHeader`.`onPointerMove$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:67
`onPointerOut$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`SpreadsheetHeader`.`onPointerOut$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:69
`onPointerOver$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`SpreadsheetHeader`.`onPointerOver$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:70
`onPointerUp$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`SpreadsheetHeader`.`onPointerUp$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:68
`onTransformChange$`	`public`	`EventSubject`<`ITransformChangeState`>	`undefined`	`SpreadsheetHeader`.`onTransformChange$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:64
`onTripleClick$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	`SpreadsheetHeader`.`onTripleClick$`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:75

Accessors

ancestorGroup

Get Signature

get ancestorGroup(): Nullable<BaseObject>

Returns

Nullable<BaseObject>

Inherited from

SpreadsheetHeader.ancestorGroup

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:251

ancestorLeft

Get Signature

get ancestorLeft(): any

Returns

any

Inherited from

SpreadsheetHeader.ancestorLeft

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:235

ancestorScaleX

Get Signature

get ancestorScaleX(): number

Returns

number

Inherited from

SpreadsheetHeader.ancestorScaleX

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:225

ancestorScaleY

Get Signature

get ancestorScaleY(): number

Returns

number

Inherited from

SpreadsheetHeader.ancestorScaleY

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:230

ancestorTop

Get Signature

get ancestorTop(): any

Returns

any

Inherited from

SpreadsheetHeader.ancestorTop

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:239

ancestorTransform

Get Signature

get ancestorTransform(): any

Returns

any

Inherited from

SpreadsheetHeader.ancestorTransform

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:243

angle

Get Signature

get angle(): number

Returns

number

Set Signature

set angle(angle): void

Parameters

Parameter	Type
`angle`	`number`

Returns

void

Inherited from

SpreadsheetHeader.angle

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:213

classType

Get Signature

get classType(): RENDER_CLASS_TYPE

Returns

RENDER_CLASS_TYPE

Inherited from

SpreadsheetHeader.classType

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:189

cursor

Get Signature

get cursor(): CURSOR_TYPE

Returns

CURSOR_TYPE

Set Signature

set cursor(val): void

Parameters

Parameter	Type
`val`	`CURSOR_TYPE`

Returns

void

Inherited from

SpreadsheetHeader.cursor

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:303

debounceParentDirty

Get Signature

get debounceParentDirty(): boolean

Returns

boolean

Set Signature

set debounceParentDirty(state): void

Parameters

Parameter	Type
`state`	`boolean`

Returns

void

Inherited from

SpreadsheetHeader.debounceParentDirty

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:299

evented

Get Signature

get evented(): boolean

Returns

boolean

Set Signature

set evented(state): void

Parameters

Parameter	Type
`state`	`boolean`

Returns

void

Inherited from

SpreadsheetHeader.evented

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:291

extensions

Get Signature

get extensions(): Map<string, ComponentExtension<T, U, V>>

Returns

Map<string, ComponentExtension<T, U, V>>

Inherited from

SpreadsheetHeader.extensions

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/component.ts:27

flipX

Get Signature

get flipX(): boolean

Returns

boolean

Set Signature

set flipX(flipX): void

Parameters

Parameter	Type
`flipX`	`boolean`

Returns

void

Inherited from

SpreadsheetHeader.flipX

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:271

flipY

Get Signature

get flipY(): boolean

Returns

boolean

Set Signature

set flipY(flipY): void

Parameters

Parameter	Type
`flipY`	`boolean`

Returns

void

Inherited from

SpreadsheetHeader.flipY

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:275

height

Get Signature

get height(): number

Returns

number

Set Signature

set height(num): void

Parameters

Parameter	Type
`num`	`string` \| `number`

Returns

void

Inherited from

SpreadsheetHeader.height

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:205

heightOrigin

Get Signature

get heightOrigin(): string | number

Returns

string | number

Inherited from

SpreadsheetHeader.heightOrigin

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:185

layer

Get Signature

get layer(): Nullable<Layer>

Returns

Nullable<Layer>

Set Signature

set layer(layer): void

Parameters

Parameter	Type
`layer`	`Layer`

Returns

void

Inherited from

SpreadsheetHeader.layer

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:307

left

Get Signature

get left(): number

Returns

number

Set Signature

set left(num): void

Parameters

Parameter	Type
`num`	`string` \| `number`

Returns

void

Inherited from

SpreadsheetHeader.left

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:197

leftOrigin

Get Signature

get leftOrigin(): string | number

Returns

string | number

Inherited from

SpreadsheetHeader.leftOrigin

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:177

maxZIndex

Get Signature

get maxZIndex(): number

Returns

number

Inherited from

SpreadsheetHeader.maxZIndex

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:399

oKey

Get Signature

get oKey(): string

Returns

string

Inherited from

SpreadsheetHeader.oKey

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:283

parent

Get Signature

get parent(): any

Returns

any

Set Signature

set parent(o): void

Parameters

Parameter	Type
`o`	`any`

Returns

void

Inherited from

SpreadsheetHeader.parent

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:279

printable

Get Signature

get printable(): boolean

Returns

boolean

Inherited from

SpreadsheetHeader.printable

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:169

rowHeaderLayoutExtension

Get Signature

get rowHeaderLayoutExtension(): RowHeaderLayout

Returns

RowHeaderLayout

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/row-header.ts:49

scaleX

Get Signature

get scaleX(): number

Returns

number

Set Signature

set scaleX(scaleX): void

Parameters

Parameter	Type
`scaleX`	`number`

Returns

void

Inherited from

SpreadsheetHeader.scaleX

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:217

scaleY

Get Signature

get scaleY(): number

Returns

number

Set Signature

set scaleY(scaleY): void

Parameters

Parameter	Type
`scaleY`	`number`

Returns

void

Inherited from

SpreadsheetHeader.scaleY

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:221

skewX

Get Signature

get skewX(): number

Returns

number

Set Signature

set skewX(skewX): void

Parameters

Parameter	Type
`skewX`	`number`

Returns

void

Inherited from

SpreadsheetHeader.skewX

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:263

skewY

Get Signature

get skewY(): number

Returns

number

Set Signature

set skewY(skewY): void

Parameters

Parameter	Type
`skewY`	`number`

Returns

void

Inherited from

SpreadsheetHeader.skewY

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:267

strokeWidth

Get Signature

get strokeWidth(): number

Returns

number

Set Signature

set strokeWidth(width): void

Parameters

Parameter	Type
`width`	`number`

Returns

void

Inherited from

SpreadsheetHeader.strokeWidth

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:209

top

Get Signature

get top(): number

Returns

number

Set Signature

set top(num): void

Parameters

Parameter	Type
`num`	`string` \| `number`

Returns

void

Inherited from

SpreadsheetHeader.top

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:193

topOrigin

Get Signature

get topOrigin(): string | number

Returns

string | number

Inherited from

SpreadsheetHeader.topOrigin

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:173

transform

Get Signature

get transform(): Transform

Returns

Transform

Set Signature

set transform(trans): void

Parameters

Parameter	Type
`trans`	`Transform`

Returns

void

Inherited from

SpreadsheetHeader.transform

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:148

transformerConfig

Get Signature

get transformerConfig(): ITransformerConfig

Returns

ITransformerConfig

Set Signature

set transformerConfig(config): void

Parameters

Parameter	Type
`config`	`ITransformerConfig`

Returns

void

Inherited from

SpreadsheetHeader.transformerConfig

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:391

visible

Get Signature

get visible(): boolean

Returns

boolean

Inherited from

SpreadsheetHeader.visible

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:295

width

Get Signature

get width(): number

Returns

number

Set Signature

set width(num): void

Parameters

Parameter	Type
`num`	`string` \| `number`

Returns

void

Inherited from

SpreadsheetHeader.width

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:201

widthOrigin

Get Signature

get widthOrigin(): string | number

Returns

string | number

Inherited from

SpreadsheetHeader.widthOrigin

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:181

zIndex

Get Signature

get zIndex(): number

Returns

number

Set Signature

set zIndex(index): void

Parameters

Parameter	Type
`index`	`number`

Returns

void

Inherited from

SpreadsheetHeader.zIndex

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:287

Methods

_draw()

protected _draw(ctx, bounds?): void

Parameters

Parameter	Type
`ctx`	`UniverRenderingContext`
`bounds`?	`IViewportInfo`

Returns

void

Inherited from

SpreadsheetHeader._draw

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:98

_setTransForm()

protected _setTransForm(): void

Returns

void

Inherited from

SpreadsheetHeader._setTransForm

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:851

applyTransform()

applyTransform(): void

Returns

void

Inherited from

SpreadsheetHeader.applyTransform

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:839

dispose()

dispose(): void

TODO: DR-Univer, fix as unknown as

Returns

void

Inherited from

SpreadsheetHeader.dispose

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:91

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

SpreadsheetHeader.disposeWithMe

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:96

draw()

draw(ctx, bounds?): void

Parameters

Parameter	Type
`ctx`	`UniverRenderingContext`
`bounds`?	`IViewportInfo`

Returns

void

Overrides

SpreadsheetHeader.draw

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/row-header.ts:53

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

SpreadsheetHeader.ensureNotDisposed

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:100

flip()

flip(flipX?, flipY?): SpreadsheetRowHeader

Parameters

Parameter	Type
`flipX`?	`boolean`
`flipY`?	`boolean`

Returns

SpreadsheetRowHeader

Inherited from

SpreadsheetHeader.flip

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:522

getDocuments()

getDocuments(): void

Returns

void

Overrides

SpreadsheetHeader.getDocuments

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/row-header.ts:26

getEngine()

getEngine(): Nullable<Engine>

Returns

Nullable<Engine>

Inherited from

SpreadsheetHeader.getEngine

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:817

getExtensionByKey()

getExtensionByKey(uKey): undefined | ComponentExtension<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]>

Parameters

Parameter	Type
`uKey`	`string`

Returns

undefined | ComponentExtension<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]>

Inherited from

SpreadsheetHeader.getExtensionByKey

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/component.ts:57

getExtensionsByOrder()

getExtensionsByOrder(): ComponentExtension<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]>[]

Returns

ComponentExtension<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]>[]

Inherited from

SpreadsheetHeader.getExtensionsByOrder

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/component.ts:50

getInverseCoord()

getInverseCoord(coord): Vector2

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

Vector2

Inherited from

SpreadsheetHeader.getInverseCoord

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:847

getLayerIndex()

getLayerIndex(): number

Returns

number

Inherited from

SpreadsheetHeader.getLayerIndex

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:832

getNoMergeCellPositionByIndex()

getNoMergeCellPositionByIndex(rowIndex, columnIndex): Nullable<{
  endX: number;
  endY: number;
  startX: number;
  startY: number;
}>

Parameters

Parameter	Type
`rowIndex`	`number`
`columnIndex`	`number`

Returns

Nullable<{ endX: number; endY: number; startX: number; startY: number; }>

Name	Type	Defined in
`endX`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/row-header.ts:30
`endY`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/row-header.ts:30
`startX`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/row-header.ts:30
`startY`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/row-header.ts:30

Overrides

SpreadsheetHeader.getNoMergeCellPositionByIndex

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/row-header.ts:30

getObjects()

getObjects(): BaseObject[]

Returns

BaseObject[]

Inherited from

SpreadsheetHeader.getObjects

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:828

getParent()

getParent(): any

Returns

any

Inherited from

SpreadsheetHeader.getParent

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:580

getParentScale()

getParentScale(): {
  scaleX: number;
  scaleY: number;
}

Returns

{
  scaleX: number;
  scaleY: number;
}

Name	Type	Defined in
`scaleX`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:63
`scaleY`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:64

Inherited from

SpreadsheetHeader.getParentScale

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:54

getScene()

getScene(): Nullable<Scene>

Returns

Nullable<Scene>

Inherited from

SpreadsheetHeader.getScene

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:796

getScrollXYByRelativeCoords()

getScrollXYByRelativeCoords(coord): {
  x: 0;
  y: 0;
}

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

{
  x: 0;
  y: 0;
}

Name	Type	Default value	Defined in
`x`	`number`	0	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:76
`y`	`number`	0	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:76

Inherited from

SpreadsheetHeader.getScrollXYByRelativeCoords

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:75

getSelectionBounding()

getSelectionBounding(
   startRow, 
   startColumn, 
   endRow, 
   endColumn): Nullable<{
  endColumn: number;
  endRow: number;
  startColumn: number;
  startRow: number;
}>

Parameters

Parameter	Type
`startRow`	`number`
`startColumn`	`number`
`endRow`	`number`
`endColumn`	`number`

Returns

Nullable<{ endColumn: number; endRow: number; startColumn: number; startRow: number; }>

Name	Type	Defined in
`endColumn`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/row-header.ts:34
`endRow`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/row-header.ts:34
`startColumn`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/row-header.ts:34
`startRow`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/row-header.ts:34

Overrides

SpreadsheetHeader.getSelectionBounding

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/row-header.ts:34

getSkeleton()

getSkeleton(): undefined | SpreadsheetSkeleton

isHit()

isHit(coord): boolean

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

boolean

Overrides

SpreadsheetHeader.isHit

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/row-header.ts:85

isRender()

isRender(bounds?): undefined | boolean

Parameters

Parameter	Type
`bounds`?	`IViewportInfo`

Returns

undefined | boolean

Inherited from

SpreadsheetHeader.isRender

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:573

makeDirty()

makeDirty(state): undefined | SpreadsheetRowHeader

Parameters

Parameter	Type	Default value
`state`	`boolean`	`true`

Returns

undefined | SpreadsheetRowHeader

Inherited from

SpreadsheetHeader.makeDirty

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:403

makeDirtyNoDebounce()

makeDirtyNoDebounce(state): SpreadsheetRowHeader

Parameters

Parameter	Type	Default value
`state`	`boolean`	`true`

Returns

SpreadsheetRowHeader

Inherited from

SpreadsheetHeader.makeDirtyNoDebounce

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:422

makeForceDirty()

makeForceDirty(state): void

Parameters

Parameter	Type	Default value
`state`	`boolean`	`true`

Returns

void

Inherited from

SpreadsheetHeader.makeForceDirty

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:418

register()

register(...extensions): IDisposable

Parameters

Parameter	Type
…`extensions`	`ComponentExtension`<`SpreadsheetSkeleton`, `SHEET_EXTENSION_TYPE`, `IRange`[]>[]

Returns

IDisposable

Inherited from

SpreadsheetHeader.register

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/component.ts:31

removeTransform()

removeTransform(): void

Returns

void

Inherited from

SpreadsheetHeader.removeTransform

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:843

render()

render(mainCtx, bounds?): undefined | SpreadsheetRowHeader

Parameters

Parameter	Type
`mainCtx`	`UniverRenderingContext`
`bounds`?	`IViewportInfo`

Returns

undefined | SpreadsheetRowHeader

Inherited from

SpreadsheetHeader.render

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:43

resetCursor()

resetCursor(): void

Returns

void

Inherited from

SpreadsheetHeader.resetCursor

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:808

resize()

resize(width?, height?): SpreadsheetRowHeader

Parameters

Parameter	Type
`width`?	`string` \| `number`
`height`?	`string` \| `number`

Returns

SpreadsheetRowHeader

Inherited from

SpreadsheetHeader.resize

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:457

scale()

scale(scaleX?, scaleY?): SpreadsheetRowHeader

Parameters

Parameter	Type
`scaleX`?	`number`
`scaleY`?	`number`

Returns

SpreadsheetRowHeader

Inherited from

SpreadsheetHeader.scale

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:478

setCursor()

setCursor(val): void

Parameters

Parameter	Type
`val`	`CURSOR_TYPE`

Returns

void

Inherited from

SpreadsheetHeader.setCursor

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:812

setCustomHeader()

setCustomHeader(cfg): void

Parameters

Parameter	Type
`cfg`	`IRowsHeaderCfgParam`

Returns

void

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/row-header.ts:105

show()

show(): void

Returns

void

Inherited from

SpreadsheetHeader.show

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:605

skew()

skew(skewX?, skewY?): SpreadsheetRowHeader

Parameters

Parameter	Type
`skewX`?	`number`
`skewY`?	`number`

Returns

SpreadsheetRowHeader

Inherited from

SpreadsheetHeader.skew

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:500

toJson()

toJson(): IKeyValue

Returns

IKeyValue

Inherited from

SpreadsheetHeader.toJson

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:785

transformByState()

transformByState(option): undefined | SpreadsheetRowHeader

this[pKey] = option[pKey]

Parameters

Parameter	Type
`option`	`IObjectFullState`

Returns

undefined | SpreadsheetRowHeader

Inherited from

SpreadsheetHeader.transformByState

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:547

transformForAngle()

transformForAngle(transform): Transform

Parameters

Parameter	Type
`transform`	`Transform`

Returns

Transform

Inherited from

SpreadsheetHeader.transformForAngle

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:153

translate()

translate(x?, y?): SpreadsheetRowHeader

Parameters

Parameter	Type
`x`?	`string` \| `number`
`y`?	`string` \| `number`

Returns

SpreadsheetRowHeader

Inherited from

SpreadsheetHeader.translate

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:435

triggerDblclick()

triggerDblclick(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

SpreadsheetHeader.triggerDblclick

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:651

triggerDragEnter()

triggerDragEnter(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IDragEvent`

Returns

boolean

Inherited from

SpreadsheetHeader.triggerDragEnter

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:737

triggerDragLeave()

triggerDragLeave(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IDragEvent`

Returns

boolean

Inherited from

SpreadsheetHeader.triggerDragLeave

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:721

triggerDragOver()

triggerDragOver(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IDragEvent`

Returns

boolean

Inherited from

SpreadsheetHeader.triggerDragOver

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:729

triggerDrop()

triggerDrop(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IDragEvent`

Returns

boolean

Inherited from

SpreadsheetHeader.triggerDrop

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:745

triggerMouseWheel()

triggerMouseWheel(evt): boolean

Parameters

Parameter	Type
`evt`	`IWheelEvent`

Returns

boolean

Inherited from

SpreadsheetHeader.triggerMouseWheel

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:671

triggerPointerDown()

triggerPointerDown(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

SpreadsheetHeader.triggerPointerDown

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:635

triggerPointerEnter()

triggerPointerEnter(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

SpreadsheetHeader.triggerPointerEnter

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:713

triggerPointerLeave()

triggerPointerLeave(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

SpreadsheetHeader.triggerPointerLeave

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:697

triggerPointerMove()

triggerPointerMove(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

SpreadsheetHeader.triggerPointerMove

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:627

triggerPointerOut()

triggerPointerOut(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

SpreadsheetHeader.triggerPointerOut

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:689

triggerPointerOver()

triggerPointerOver(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

SpreadsheetHeader.triggerPointerOver

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:705

triggerPointerUp()

triggerPointerUp(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

SpreadsheetHeader.triggerPointerUp

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:643

triggerTripleClick()

triggerTripleClick(evt): boolean

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

boolean

Inherited from

SpreadsheetHeader.triggerTripleClick

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:661

updateSkeleton()

updateSkeleton(spreadsheetSkeleton): void

Parameters

Parameter	Type
`spreadsheetSkeleton`	`SpreadsheetSkeleton`

Returns

void

Inherited from

SpreadsheetHeader.updateSkeleton

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:38

Spreadsheetheader Spreadsheetskeleton