@univerjsengine-renderclassesSpreadsheetrowheader

@univerjs/engine-render v0.5.4


Class: SpreadsheetRowHeader

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

Extends

Constructors

new SpreadsheetRowHeader()

new SpreadsheetRowHeader(oKey, spreadsheetSkeleton?): SpreadsheetRowHeader

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

Parameters

ParameterType
oKeystring
spreadsheetSkeleton?SpreadsheetSkeleton

Returns

SpreadsheetRowHeader

Overrides

SpreadsheetHeader.constructor

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_dirtyprotectedbooleantrueSpreadsheetHeader._dirtypackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:88
_disposedprotectedbooleanfalseSpreadsheetHeader._disposedpackages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:96
_forceDirtyprotectedbooleantrueSpreadsheetHeader._forceDirtypackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:89
_oKeyprotectedstringundefinedSpreadsheetHeader._oKeypackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:86
groupKey?publicstringundefinedSpreadsheetHeader.groupKeypackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:59
isInGrouppublicbooleanfalseSpreadsheetHeader.isInGrouppackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:60
objectTypepublicObjectTypeObjectType.UNKNOWNSpreadsheetHeader.objectTypepackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:62
onDblclick$publicEventSubject< | IMouseEvent | IPointerEvent>undefinedSpreadsheetHeader.onDblclick$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:74
onDispose$publicEventSubject<BaseObject>undefinedSpreadsheetHeader.onDispose$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:84
onDragEnter$publicEventSubject< | IMouseEvent | IDragEvent>undefinedSpreadsheetHeader.onDragEnter$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:80
onDragLeave$publicEventSubject< | IMouseEvent | IDragEvent>undefinedSpreadsheetHeader.onDragLeave$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:78
onDragOver$publicEventSubject< | IMouseEvent | IDragEvent>undefinedSpreadsheetHeader.onDragOver$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:79
onDrop$publicEventSubject< | IMouseEvent | IDragEvent>undefinedSpreadsheetHeader.onDrop$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:81
onIsAddedToParent$publicEventSubject<any>undefinedSpreadsheetHeader.onIsAddedToParent$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:83
onMouseWheel$publicEventSubject<IWheelEvent>undefinedSpreadsheetHeader.onMouseWheel$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:76
onPointerDown$publicEventSubject< | IMouseEvent | IPointerEvent>undefinedSpreadsheetHeader.onPointerDown$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:66
onPointerEnter$publicEventSubject< | IMouseEvent | IPointerEvent>undefinedSpreadsheetHeader.onPointerEnter$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:72
onPointerLeave$publicEventSubject< | IMouseEvent | IPointerEvent>undefinedSpreadsheetHeader.onPointerLeave$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:71
onPointerMove$publicEventSubject< | IMouseEvent | IPointerEvent>undefinedSpreadsheetHeader.onPointerMove$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:67
onPointerOut$publicEventSubject< | IMouseEvent | IPointerEvent>undefinedSpreadsheetHeader.onPointerOut$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:69
onPointerOver$publicEventSubject< | IMouseEvent | IPointerEvent>undefinedSpreadsheetHeader.onPointerOver$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:70
onPointerUp$publicEventSubject< | IMouseEvent | IPointerEvent>undefinedSpreadsheetHeader.onPointerUp$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:68
onTransformChange$publicEventSubject<ITransformChangeState>undefinedSpreadsheetHeader.onTransformChange$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:64
onTripleClick$publicEventSubject< | IMouseEvent | IPointerEvent>undefinedSpreadsheetHeader.onTripleClick$packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/base-object.ts:75

Accessors

ancestorGroup

Get Signature

get ancestorGroup(): Nullable<BaseObject>

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

Returns

Nullable<BaseObject>

Inherited from

SpreadsheetHeader.ancestorGroup


ancestorLeft

Get Signature

get ancestorLeft(): any

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

Returns

any

Inherited from

SpreadsheetHeader.ancestorLeft


ancestorScaleX

Get Signature

get ancestorScaleX(): number

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

Returns

number

Inherited from

SpreadsheetHeader.ancestorScaleX


ancestorScaleY

Get Signature

get ancestorScaleY(): number

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

Returns

number

Inherited from

SpreadsheetHeader.ancestorScaleY


ancestorTop

Get Signature

get ancestorTop(): any

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

Returns

any

Inherited from

SpreadsheetHeader.ancestorTop


ancestorTransform

Get Signature

get ancestorTransform(): any

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

Returns

any

Inherited from

SpreadsheetHeader.ancestorTransform


angle

Get Signature

get angle(): number

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

Returns

number

Set Signature

set angle(angle): void

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

Parameters
ParameterType
anglenumber
Returns

void

Inherited from

SpreadsheetHeader.angle


classType

Get Signature

get classType(): RENDER_CLASS_TYPE

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

Returns

RENDER_CLASS_TYPE

Inherited from

SpreadsheetHeader.classType


cursor

Get Signature

get cursor(): CURSOR_TYPE

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

Returns

CURSOR_TYPE

Set Signature

set cursor(val): void

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

Parameters
ParameterType
valCURSOR_TYPE
Returns

void

Inherited from

SpreadsheetHeader.cursor


debounceParentDirty

Get Signature

get debounceParentDirty(): boolean

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

Returns

boolean

Set Signature

set debounceParentDirty(state): void

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

Parameters
ParameterType
stateboolean
Returns

void

Inherited from

SpreadsheetHeader.debounceParentDirty


evented

Get Signature

get evented(): boolean

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

Returns

boolean

Set Signature

set evented(state): void

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

Parameters
ParameterType
stateboolean
Returns

void

Inherited from

SpreadsheetHeader.evented


extensions

Get Signature

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

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

Returns

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

Inherited from

SpreadsheetHeader.extensions


flipX

Get Signature

get flipX(): boolean

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

Returns

boolean

Set Signature

set flipX(flipX): void

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

Parameters
ParameterType
flipXboolean
Returns

void

Inherited from

SpreadsheetHeader.flipX


flipY

Get Signature

get flipY(): boolean

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

Returns

boolean

Set Signature

set flipY(flipY): void

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

Parameters
ParameterType
flipYboolean
Returns

void

Inherited from

SpreadsheetHeader.flipY


height

Get Signature

get height(): number

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

Returns

number

Set Signature

set height(num): void

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

Parameters
ParameterType
numstring | number
Returns

void

Inherited from

SpreadsheetHeader.height


heightOrigin

Get Signature

get heightOrigin(): string | number

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

Returns

string | number

Inherited from

SpreadsheetHeader.heightOrigin


layer

Get Signature

get layer(): Nullable<Layer>

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

Returns

Nullable<Layer>

Set Signature

set layer(layer): void

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

Parameters
ParameterType
layerLayer
Returns

void

Inherited from

SpreadsheetHeader.layer


left

Get Signature

get left(): number

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

Returns

number

Set Signature

set left(num): void

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

Parameters
ParameterType
numstring | number
Returns

void

Inherited from

SpreadsheetHeader.left


leftOrigin

Get Signature

get leftOrigin(): string | number

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

Returns

string | number

Inherited from

SpreadsheetHeader.leftOrigin


maxZIndex

Get Signature

get maxZIndex(): number

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

Returns

number

Inherited from

SpreadsheetHeader.maxZIndex


oKey

Get Signature

get oKey(): string

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

Returns

string

Inherited from

SpreadsheetHeader.oKey


parent

Get Signature

get parent(): any

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

Returns

any

Set Signature

set parent(o): void

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

Parameters
ParameterType
oany
Returns

void

Inherited from

SpreadsheetHeader.parent


printable

Get Signature

get printable(): boolean

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

Returns

boolean

Inherited from

SpreadsheetHeader.printable


rowHeaderLayoutExtension

Get Signature

get rowHeaderLayoutExtension(): RowHeaderLayout

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

Returns

RowHeaderLayout


scaleX

Get Signature

get scaleX(): number

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

Returns

number

Set Signature

set scaleX(scaleX): void

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

Parameters
ParameterType
scaleXnumber
Returns

void

Inherited from

SpreadsheetHeader.scaleX


scaleY

Get Signature

get scaleY(): number

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

Returns

number

Set Signature

set scaleY(scaleY): void

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

Parameters
ParameterType
scaleYnumber
Returns

void

Inherited from

SpreadsheetHeader.scaleY


skewX

Get Signature

get skewX(): number

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

Returns

number

Set Signature

set skewX(skewX): void

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

Parameters
ParameterType
skewXnumber
Returns

void

Inherited from

SpreadsheetHeader.skewX


skewY

Get Signature

get skewY(): number

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

Returns

number

Set Signature

set skewY(skewY): void

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

Parameters
ParameterType
skewYnumber
Returns

void

Inherited from

SpreadsheetHeader.skewY


strokeWidth

Get Signature

get strokeWidth(): number

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

Returns

number

Set Signature

set strokeWidth(width): void

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

Parameters
ParameterType
widthnumber
Returns

void

Inherited from

SpreadsheetHeader.strokeWidth


top

Get Signature

get top(): number

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

Returns

number

Set Signature

set top(num): void

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

Parameters
ParameterType
numstring | number
Returns

void

Inherited from

SpreadsheetHeader.top


topOrigin

Get Signature

get topOrigin(): string | number

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

Returns

string | number

Inherited from

SpreadsheetHeader.topOrigin


transform

Get Signature

get transform(): Transform

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

Returns

Transform

Set Signature

set transform(trans): void

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

Parameters
ParameterType
transTransform
Returns

void

Inherited from

SpreadsheetHeader.transform


transformerConfig

Get Signature

get transformerConfig(): ITransformerConfig

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

Returns

ITransformerConfig

Set Signature

set transformerConfig(config): void

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

Parameters
ParameterType
configITransformerConfig
Returns

void

Inherited from

SpreadsheetHeader.transformerConfig


visible

Get Signature

get visible(): boolean

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

Returns

boolean

Inherited from

SpreadsheetHeader.visible


width

Get Signature

get width(): number

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

Returns

number

Set Signature

set width(num): void

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

Parameters
ParameterType
numstring | number
Returns

void

Inherited from

SpreadsheetHeader.width


widthOrigin

Get Signature

get widthOrigin(): string | number

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

Returns

string | number

Inherited from

SpreadsheetHeader.widthOrigin


zIndex

Get Signature

get zIndex(): number

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

Returns

number

Set Signature

set zIndex(index): void

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

Parameters
ParameterType
indexnumber
Returns

void

Inherited from

SpreadsheetHeader.zIndex

Methods

_draw()

protected _draw(ctx, bounds?): void

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

Parameters

ParameterType
ctxUniverRenderingContext
bounds?IViewportInfo

Returns

void

Inherited from

SpreadsheetHeader._draw


_setTransForm()

protected _setTransForm(): void

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

Returns

void

Inherited from

SpreadsheetHeader._setTransForm


applyTransform()

applyTransform(): void

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

Returns

void

Inherited from

SpreadsheetHeader.applyTransform


dispose()

dispose(): void

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

TODO: DR-Univer, fix as unknown as

Returns

void

Inherited from

SpreadsheetHeader.dispose


disposeWithMe()

disposeWithMe(disposable): IDisposable

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:99

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

SpreadsheetHeader.disposeWithMe


draw()

draw(ctx, bounds?): void

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

Parameters

ParameterType
ctxUniverRenderingContext
bounds?IViewportInfo

Returns

void

Overrides

SpreadsheetHeader.draw


ensureNotDisposed()

protected ensureNotDisposed(): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:103

Returns

void

Inherited from

SpreadsheetHeader.ensureNotDisposed


flip()

flip(flipX?, flipY?): SpreadsheetRowHeader

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

Parameters

ParameterType
flipX?boolean
flipY?boolean

Returns

SpreadsheetRowHeader

Inherited from

SpreadsheetHeader.flip


getDocuments()

getDocuments(): void

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

Returns

void

Overrides

SpreadsheetHeader.getDocuments


getEngine()

getEngine(): Nullable<Engine>

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

Returns

Nullable<Engine>

Inherited from

SpreadsheetHeader.getEngine


getExtensionByKey()

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

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

Parameters

ParameterType
uKeystring

Returns

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

Inherited from

SpreadsheetHeader.getExtensionByKey


getExtensionsByOrder()

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

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

Returns

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

Inherited from

SpreadsheetHeader.getExtensionsByOrder


getInverseCoord()

getInverseCoord(coord): Vector2

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

Parameters

ParameterType
coordVector2

Returns

Vector2

Inherited from

SpreadsheetHeader.getInverseCoord


getLayerIndex()

getLayerIndex(): number

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

Returns

number

Inherited from

SpreadsheetHeader.getLayerIndex


getNoMergeCellPositionByIndex()

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

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

Parameters

ParameterType
rowIndexnumber
columnIndexnumber

Returns

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

Overrides

SpreadsheetHeader.getNoMergeCellPositionByIndex


getObjects()

getObjects(): BaseObject[]

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

Returns

BaseObject[]

Inherited from

SpreadsheetHeader.getObjects


getParent()

getParent(): any

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

Returns

any

Inherited from

SpreadsheetHeader.getParent


getParentScale()

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

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

Returns

{
  scaleX: number;
  scaleY: number;
}
NameTypeDefined in
scaleXnumberpackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:63
scaleYnumberpackages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:64

Inherited from

SpreadsheetHeader.getParentScale


getScene()

getScene(): Nullable<Scene>

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

Returns

Nullable<Scene>

Inherited from

SpreadsheetHeader.getScene


getScrollXYByRelativeCoords()

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

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

Parameters

ParameterType
coordVector2

Returns

{
  x: number;
  y: number;
}
NameTypeDefault valueDefined in
xnumber0packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:76
ynumber0packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-component.ts:76

Inherited from

SpreadsheetHeader.getScrollXYByRelativeCoords


getSelectionBounding()

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

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

Parameters

ParameterType
startRownumber
startColumnnumber
endRownumber
endColumnnumber

Returns

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

Overrides

SpreadsheetHeader.getSelectionBounding


getSkeleton()

getSkeleton(): undefined | SpreadsheetSkeleton

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

Returns

undefined | SpreadsheetSkeleton

Inherited from

SpreadsheetHeader.getSkeleton


getState()

getState(): ITransformState

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

Returns

ITransformState

Inherited from

SpreadsheetHeader.getState


hide()

hide(): void

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

Returns

void

Inherited from

SpreadsheetHeader.hide


isDirty()

isDirty(): boolean

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

Returns

boolean

Inherited from

SpreadsheetHeader.isDirty


isHit()

isHit(coord): boolean

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

Parameters

ParameterType
coordVector2

Returns

boolean

Overrides

SpreadsheetHeader.isHit


isRender()

isRender(bounds?): undefined | boolean

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

Parameters

ParameterType
bounds?IViewportInfo

Returns

undefined | boolean

Inherited from

SpreadsheetHeader.isRender


makeDirty()

makeDirty(state): undefined | SpreadsheetRowHeader

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

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

undefined | SpreadsheetRowHeader

Inherited from

SpreadsheetHeader.makeDirty


makeDirtyNoDebounce()

makeDirtyNoDebounce(state): SpreadsheetRowHeader

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

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

SpreadsheetRowHeader

Inherited from

SpreadsheetHeader.makeDirtyNoDebounce


makeForceDirty()

makeForceDirty(state): void

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

Parameters

ParameterTypeDefault value
statebooleantrue

Returns

void

Inherited from

SpreadsheetHeader.makeForceDirty


register()

register(...extensions): IDisposable

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

Parameters

ParameterType
extensionsComponentExtension<SpreadsheetSkeleton, GRID, IRange[]>[]

Returns

IDisposable

Inherited from

SpreadsheetHeader.register


removeTransform()

removeTransform(): void

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

Returns

void

Inherited from

SpreadsheetHeader.removeTransform


render()

render(mainCtx, bounds?): undefined | SpreadsheetRowHeader

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

Parameters

ParameterType
mainCtxUniverRenderingContext
bounds?IViewportInfo

Returns

undefined | SpreadsheetRowHeader

Inherited from

SpreadsheetHeader.render


resetCursor()

resetCursor(): void

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

Returns

void

Inherited from

SpreadsheetHeader.resetCursor


resize()

resize(width?, height?): SpreadsheetRowHeader

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

Parameters

ParameterType
width?string | number
height?string | number

Returns

SpreadsheetRowHeader

Inherited from

SpreadsheetHeader.resize


scale()

scale(scaleX?, scaleY?): SpreadsheetRowHeader

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

Parameters

ParameterType
scaleX?number
scaleY?number

Returns

SpreadsheetRowHeader

Inherited from

SpreadsheetHeader.scale


setCursor()

setCursor(val): void

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

Parameters

ParameterType
valCURSOR_TYPE

Returns

void

Inherited from

SpreadsheetHeader.setCursor


setCustomHeader()

setCustomHeader(cfg): void

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

Parameters

ParameterType
cfgIRowsHeaderCfgParam

Returns

void


show()

show(): void

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

Returns

void

Inherited from

SpreadsheetHeader.show


skew()

skew(skewX?, skewY?): SpreadsheetRowHeader

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

Parameters

ParameterType
skewX?number
skewY?number

Returns

SpreadsheetRowHeader

Inherited from

SpreadsheetHeader.skew


toJson()

toJson(): IKeyValue

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

Returns

IKeyValue

Inherited from

SpreadsheetHeader.toJson


transformByState()

transformByState(option): undefined | SpreadsheetRowHeader

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

this[pKey] = option[pKey]

Parameters

ParameterType
optionIObjectFullState

Returns

undefined | SpreadsheetRowHeader

Inherited from

SpreadsheetHeader.transformByState


transformForAngle()

transformForAngle(transform): Transform

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

Parameters

ParameterType
transformTransform

Returns

Transform

Inherited from

SpreadsheetHeader.transformForAngle


translate()

translate(x?, y?): SpreadsheetRowHeader

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

Parameters

ParameterType
x?string | number
y?string | number

Returns

SpreadsheetRowHeader

Inherited from

SpreadsheetHeader.translate


triggerDblclick()

triggerDblclick(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean

Inherited from

SpreadsheetHeader.triggerDblclick


triggerDragEnter()

triggerDragEnter(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IDragEvent

Returns

boolean

Inherited from

SpreadsheetHeader.triggerDragEnter


triggerDragLeave()

triggerDragLeave(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IDragEvent

Returns

boolean

Inherited from

SpreadsheetHeader.triggerDragLeave


triggerDragOver()

triggerDragOver(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IDragEvent

Returns

boolean

Inherited from

SpreadsheetHeader.triggerDragOver


triggerDrop()

triggerDrop(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IDragEvent

Returns

boolean

Inherited from

SpreadsheetHeader.triggerDrop


triggerMouseWheel()

triggerMouseWheel(evt): boolean

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

Parameters

ParameterType
evtIWheelEvent

Returns

boolean

Inherited from

SpreadsheetHeader.triggerMouseWheel


triggerPointerCancel()

triggerPointerCancel(evt): boolean

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

Parameters

ParameterType
evtIPointerEvent

Returns

boolean

Inherited from

SpreadsheetHeader.triggerPointerCancel


triggerPointerDown()

triggerPointerDown(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean

Inherited from

SpreadsheetHeader.triggerPointerDown


triggerPointerEnter()

triggerPointerEnter(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean

Inherited from

SpreadsheetHeader.triggerPointerEnter


triggerPointerLeave()

triggerPointerLeave(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean

Inherited from

SpreadsheetHeader.triggerPointerLeave


triggerPointerMove()

triggerPointerMove(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean

Inherited from

SpreadsheetHeader.triggerPointerMove


triggerPointerOut()

triggerPointerOut(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean

Inherited from

SpreadsheetHeader.triggerPointerOut


triggerPointerOver()

triggerPointerOver(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean

Inherited from

SpreadsheetHeader.triggerPointerOver


triggerPointerUp()

triggerPointerUp(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean

Inherited from

SpreadsheetHeader.triggerPointerUp


triggerTripleClick()

triggerTripleClick(evt): boolean

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

Parameters

ParameterType
evt| IMouseEvent | IPointerEvent

Returns

boolean

Inherited from

SpreadsheetHeader.triggerTripleClick


updateSkeleton()

updateSkeleton(spreadsheetSkeleton): void

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

Parameters

ParameterType
spreadsheetSkeletonSpreadsheetSkeleton

Returns

void

Inherited from

SpreadsheetHeader.updateSkeleton