Class: SpreadsheetSkeleton

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

Extends

Skeleton

Constructors

new SpreadsheetSkeleton()

new SpreadsheetSkeleton(
   worksheet, 
   _styles, 
   _localeService, 
   _contextService, 
   _configService, 
   _injector): SpreadsheetSkeleton

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

Parameters

Parameter	Type
`worksheet`	`Worksheet`
`_styles`	`Styles`
`_localeService`	`LocaleService`
`_contextService`	`IContextService`
`_configService`	`IConfigService`
`_injector`	`Injector`

Returns

SpreadsheetSkeleton

Overrides

Skeleton.constructor

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`Skeleton`.`_disposed`	packages/api/tmp/univer-pro/submodules/univer/packages/core/src/shared/lifecycle.ts:96
`_localeService`	`readonly`	`LocaleService`	`undefined`	`Skeleton`.`_localeService`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/skeleton.ts:25
`worksheet`	`readonly`	`Worksheet`	`undefined`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-skeleton.ts:264

Accessors

columnHeaderHeight

Get Signature

get columnHeaderHeight(): number

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

Returns

number

columnHeaderHeightAndMarginTop

Get Signature

get columnHeaderHeightAndMarginTop(): number

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

Returns

number

columnTotalWidth

Get Signature

get columnTotalWidth(): number

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

Returns

number

columnWidthAccumulation

Get Signature

get columnWidthAccumulation(): number[]

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

Returns

number[]

dirty

Get Signature

get dirty(): boolean

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

Returns

boolean

Inherited from

Skeleton.dirty

gridlinesColor

Get Signature

get gridlinesColor(): undefined | string

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

Returns

undefined | string

imageCacheMap

Get Signature

get imageCacheMap(): ImageCacheMap

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

Returns

ImageCacheMap

mergeData

Get Signature

get mergeData(): IRange[]

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

Returns

IRange[]

overflowCache

Get Signature

get overflowCache(): ObjectMatrix<IRange>

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

Returns

ObjectMatrix<IRange>

rowColumnSegment

Get Signature

get rowColumnSegment(): IRowColumnRange

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

Range of visible area(range in viewBounds)

Returns

IRowColumnRange

rowHeaderWidth

Get Signature

get rowHeaderWidth(): number

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

Returns

number

rowHeaderWidthAndMarginLeft

Get Signature

get rowHeaderWidthAndMarginLeft(): number

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

Returns

number

rowHeightAccumulation

Get Signature

get rowHeightAccumulation(): number[]

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

Returns

number[]

rowTotalHeight

Get Signature

get rowTotalHeight(): number

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

Returns

number

showGridlines

Get Signature

get showGridlines(): BooleanNumber

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

Returns

BooleanNumber

stylesCache

Get Signature

get stylesCache(): IStylesCache

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

Returns

IStylesCache

Methods

_getMeasuredWidthByCell()

_getMeasuredWidthByCell(cell, currColWidth): number

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

For _calculateColMaxWidth

Parameters

Parameter	Type
`cell`	`ICellDataForSheetInterceptor`
`currColWidth`	`number`

Returns

number

width

_getRangeByViewBounding()

protected _getRangeByViewBounding(
   rowHeightAccumulation, 
   columnWidthAccumulation, 
   viewBound?): IRange

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

Get the range of the bounding area of the canvas.

Parameters

Parameter	Type	Description
`rowHeightAccumulation`	`number`[]	Row layout information
`columnWidthAccumulation`	`number`[]	Column layout information
`viewBound`?	`IBoundRectNoAngle`	The range of the visible area of the canvas

Returns

IRange

The range cell index of the canvas visible area

_setBgStylesCache()

_setBgStylesCache(
   row, 
   col, 
   style, 
   options): void

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

Parameters

Parameter	Type
`row`	`number`
`col`	`number`
`style`	`Nullable`<`IStyleData`>
`options`	\| `undefined` \| { `cacheItem`: `ICacheItem`; `mergeRange`: `IRange`; }

Returns

void

_setBorderStylesCache()

_setBorderStylesCache(
   row, 
   col, 
   style, 
   options): void

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

Parameters

Parameter	Type
`row`	`number`
`col`	`number`
`style`	`Nullable`<`IStyleData`>
`options`	\| `undefined` \| { `cacheItem`: `ICacheItem`; `mergeRange`: `IRange`; }

Returns

void

_setFontStylesCache()

_setFontStylesCache(
   row, 
   col, 
   cell): void

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

Parameters

Parameter	Type
`row`	`number`
`col`	`number`
`cell`	`Nullable`<`ICellDataForSheetInterceptor`>

Returns

void

appendToOverflowCache()

appendToOverflowCache(
   row, 
   column, 
   startColumn, 
   endColumn): void

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

Parameters

Parameter	Type
`row`	`number`
`column`	`number`
`startColumn`	`number`
`endColumn`	`number`

Returns

void

calculate()

calculate(): Nullable<SpreadsheetSkeleton>

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

Refresh cache after markDirty by SheetSkeletonManagerService.reCalculate()

Returns

Nullable<SpreadsheetSkeleton>

calculateAutoHeightInRange()

calculateAutoHeightInRange(ranges): IRowAutoHeightInfo[]

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

Calc all auto height by getDocsSkeletonPageSize in ranges

Parameters

Parameter	Type
`ranges`	`Nullable`<`IRange`[]>

Returns

IRowAutoHeightInfo[]

result

calculateAutoWidthInRange()

calculateAutoWidthInRange(ranges): IColAutoWidthInfo[]

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

Parameters

Parameter	Type
`ranges`	`Nullable`<`IRange`[]>

Returns

IColAutoWidthInfo[]

calculateCellIndexByPosition()

calculateCellIndexByPosition(
   offsetX, 
   offsetY, 
   scaleX, 
   scaleY, 
scrollXY): Nullable<ICellWithCoord>

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

Get cell by pos(offsetX, offsetY).

Parameters

Parameter	Type
`offsetX`	`number`
`offsetY`	`number`
`scaleX`	`number`
`scaleY`	`number`
`scrollXY`	{ `x`: `number`; `y`: `number`; }
`scrollXY.x`	`number`
`scrollXY.y`	`number`

Returns

Nullable<ICellWithCoord>

Deprecated

Please use getCellWithCoordByOffset instead.

convertTransformToOffsetX()

convertTransformToOffsetX(
   offsetX, 
   scaleX, 
   scrollXY): number

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

convert canvas content position to physical position in screen

Parameters

Parameter	Type
`offsetX`	`number`
`scaleX`	`number`
`scrollXY`	{ `x`: `number`; `y`: `number`; }
`scrollXY.x`	`number`
`scrollXY.y`	`number`

Returns

number

convertTransformToOffsetY()

convertTransformToOffsetY(
   offsetY, 
   scaleY, 
   scrollXY): number

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

convert canvas content position to physical position in screen

Parameters

Parameter	Type
`offsetY`	`number`
`scaleY`	`number`
`scrollXY`	{ `x`: `number`; `y`: `number`; }
`scrollXY.x`	`number`
`scrollXY.y`	`number`

Returns

number

dispose()

dispose(): void

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

Returns

void

Overrides

Skeleton.dispose

disposeWithMe()

disposeWithMe(disposable): IDisposable

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

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Skeleton.disposeWithMe

ensureNotDisposed()

protected ensureNotDisposed(): void

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

Returns

void

Inherited from

Skeleton.ensureNotDisposed

expandRangeByMerge()

expandRangeByMerge(range): IRange

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

expand curr range if it’s intersect with merge range.

Parameters

Parameter	Type
`range`	`IRange`

Returns

IRange

expanded range because merge info.

getBlankCellDocumentModel()

getBlankCellDocumentModel(cell): IDocumentLayoutObject

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

Only used for cell edit, and no need to rotate text when edit cell content!

Parameters

Parameter	Type
`cell`	`Nullable`<`ICellData`>

Returns

IDocumentLayoutObject

Deprecated

use same method in worksheet.

getCacheRangeByViewport()

getCacheRangeByViewport(vpInfo?): IRange

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

Parameters

Parameter	Type
`vpInfo`?	`IViewportInfo`

Returns

IRange

getCellByIndex()

getCellByIndex(row, column): ICellWithCoord

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

Same as getCellWithCoordByIndex, but uses a different name to maintain backward compatibility with previous calls.

Parameters

Parameter	Type
`row`	`number`
`column`	`number`

Returns

ICellWithCoord

Deprecated

Please use getCellWithCoordByIndex instead.

getCellByIndexWithNoHeader()

getCellByIndexWithNoHeader(row, column): ICellWithCoord

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

Parameters

Parameter	Type
`row`	`number`
`column`	`number`

Returns

ICellWithCoord

Deprecated

Please use getCellWithCoordByIndex(row, col, false) instead.

getCellByOffset()

getCellByOffset(
   offsetX, 
   offsetY, 
   scaleX, 
   scaleY, 
scrollXY): Nullable<ICellInfo>

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

Parameters

Parameter	Type
`offsetX`	`number`
`offsetY`	`number`
`scaleX`	`number`
`scaleY`	`number`
`scrollXY`	{ `x`: `number`; `y`: `number`; }
`scrollXY.x`	`number`
`scrollXY.y`	`number`

Returns

Nullable<ICellInfo>

getCellDocumentModelWithFormula()

getCellDocumentModelWithFormula(cell): Nullable<IDocumentLayoutObject>

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

Only used for cell edit, and no need to rotate text when edit cell content!

Parameters

Parameter	Type
`cell`	`ICellData`

Returns

Nullable<IDocumentLayoutObject>

Deprecated

use same method in worksheet.

getCellIndexByOffset()

getCellIndexByOffset(
   offsetX, 
   offsetY, 
   scaleX, 
   scaleY, 
   scrollXY, 
   options?): {
  column: number;
  row: number;
}

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

Get cell index by offset(o)

Parameters

Parameter	Type	Description
`offsetX`	`number`	position X in viewport.
`offsetY`	`number`	position Y in viewport.
`scaleX`	`number`	render scene scale x-axis, scene.getAncestorScale
`scaleY`	`number`	render scene scale y-axis, scene.getAncestorScale
`scrollXY`	{ `x`: `number`; `y`: `number`; }	render viewport scroll {x, y}, scene.getScrollXYByRelativeCoords, scene.getScrollXY
`scrollXY.x`	`number`	-
`scrollXY.y`?	`number`	-
`options`?	`IGetRowColByPosOptions`	-

Returns

{
  column: number;
  row: number;
}

cell index

Name	Type	Defined in
`column`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-skeleton.ts:1175
`row`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-skeleton.ts:1175

getCellPositionByOffset()

getCellPositionByOffset(
   offsetX, 
   offsetY, 
   scaleX, 
   scaleY, 
   scrollXY, 
   options?): {
  column: number;
  row: number;
}

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

This method has the same implementation as getCellIndexByOffset, but uses a different name to maintain backward compatibility with previous calls.

Parameters

Parameter	Type
`offsetX`	`number`
`offsetY`	`number`
`scaleX`	`number`
`scaleY`	`number`
`scrollXY`	{ `x`: `number`; `y`: `number`; }
`scrollXY.x`	`number`
`scrollXY.y`?	`number`
`options`?	`IGetRowColByPosOptions`

Returns

{
  column: number;
  row: number;
}

Name	Type	Defined in
`column`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-skeleton.ts:1153
`row`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-skeleton.ts:1153

Deprecated

Please use getCellIndexByOffset method instead.

getCellWithCoordByIndex()

getCellWithCoordByIndex(
   row, 
   column, 
   header): ICellWithCoord

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

Return cell information corresponding to the current coordinates, including the merged cell object.

Parameters

Parameter	Type	Default value	Description
`row`	`number`	`undefined`	Specified Row Coordinate
`column`	`number`	`undefined`	Specified Column Coordinate
`header`	`boolean`	`true`	-

Returns

ICellWithCoord

getCellWithCoordByOffset()

getCellWithCoordByOffset(
   offsetX, 
   offsetY, 
   scaleX, 
   scaleY, 
   scrollXY, 
   options?): ICellWithCoord

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

Get cell by pos(offsetX, offsetY).

options.matchFirst true means get cell would skip all invisible cells.

Parameters

Parameter	Type	Description
`offsetX`	`number`	position X in viewport.
`offsetY`	`number`	position Y in viewport.
`scaleX`	`number`	render scene scale x-axis, scene.getAncestorScale
`scaleY`	`number`	render scene scale y-axis, scene.getAncestorScale
`scrollXY`	{ `x`: `number`; `y`: `number`; }	render viewportScroll {x, y}
`scrollXY.x`	`number`	-
`scrollXY.y`?	`number`	-
`options`?	`IGetRowColByPosOptions`	{IGetRowColByPosOptions}

Returns

ICellWithCoord

Selection data with coordinates

getCellWithMergeInfoByIndex()

getCellWithMergeInfoByIndex(row, column): Nullable<ICellInfo>

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

Parameters

Parameter	Type
`row`	`number`
`column`	`number`

Returns

Nullable<ICellInfo>

getColumnCount()

getColumnCount(): number

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

Returns

number

getColumnIndexByOffsetX()

getColumnIndexByOffsetX(
   evtOffsetX, 
   scaleX, 
   scrollXY, 
   options?): number

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

Get column index by offset x.

Parameters

Parameter	Type	Description
`evtOffsetX`	`number`	-
`scaleX`	`number`	scale x
`scrollXY`	{ `x`: `number`; `y`: `number`; }	scrollXY
`scrollXY.x`	`number`	-
`scrollXY.y`?	`number`	-
`options`?	`IGetRowColByPosOptions`	-

Returns

number

column index

getColumnPositionByOffsetX()

getColumnPositionByOffsetX(
   offsetX, 
   scaleX, 
   scrollXY, 
   options?): number

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

Same as getColumnIndexByOffsetX

Parameters

Parameter	Type
`offsetX`	`number`
`scaleX`	`number`
`scrollXY`	{ `x`: `number`; `y`: `number`; }
`scrollXY.x`	`number`
`scrollXY.y`?	`number`
`options`?	`IGetRowColByPosOptions`

Returns

number

Deprecated

Please use getColumnIndexByOffsetX method instead.

getCurrentRowColumnSegmentMergeData()

getCurrentRowColumnSegmentMergeData(range?): IRange[]

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

Get the current row and column segment visible merge data.

Parameters

Parameter	Type
`range`?	`IRange`

Returns

IRange[]

The visible merge data

getDecomposedOffset()

getDecomposedOffset(offsetX, offsetY): {
  column: number;
  columnOffset: number;
  row: number;
  rowOffset: number;
}

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

Parameters

Parameter	Type
`offsetX`	`number`
`offsetY`	`number`

Returns

{
  column: number;
  columnOffset: number;
  row: number;
  rowOffset: number;
}

Name	Type	Defined in
`column`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-skeleton.ts:1576
`columnOffset`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-skeleton.ts:1576
`row`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-skeleton.ts:1576
`rowOffset`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-skeleton.ts:1576

getDistanceFromTopLeft()

getDistanceFromTopLeft(row, col): IPoint

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

Parameters

Parameter	Type
`row`	`number`
`col`	`number`

Returns

IPoint

getFont()

getFont(rowIndex, columnIndex): Nullable<IFontCacheItem>

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

Parameters

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

Returns

Nullable<IFontCacheItem>

getFontLocale()

getFontLocale(): IFontLocale

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

Returns

IFontLocale

Inherited from

Skeleton.getFontLocale

getHiddenColumnsInRange()

getHiddenColumnsInRange(range): number[]

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

Parameters

Parameter	Type
`range`	`IColumnRange`

Returns

number[]

getHiddenRowsInRange()

getHiddenRowsInRange(range): number[]

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

Parameters

Parameter	Type
`range`	`IRowRange`

Returns

number[]

getLocation()

getLocation(): [string, string]

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

Get which Workbook and Worksheet this skeleton is attached to.

Returns

[string, string]

[unitId, sheetId]

getMergeBounding()

getMergeBounding(
   startRow, 
   startColumn, 
   endRow, 
   endColumn): IRange

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

Parameters

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

Returns

IRange

getNoMergeCellPositionByIndex()

getNoMergeCellPositionByIndex(rowIndex, columnIndex): IPosition

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

Parameters

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

Returns

IPosition

getNoMergeCellPositionByIndexWithNoHeader()

getNoMergeCellPositionByIndexWithNoHeader(rowIndex, columnIndex): IPosition

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

Parameters

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

Returns

IPosition

getOffsetByPositionX()

getOffsetByPositionX(column): number

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

Parameters

Parameter	Type
`column`	`number`

Returns

number

getOffsetByPositionY()

getOffsetByPositionY(row): number

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

Parameters

Parameter	Type
`row`	`number`

Returns

number

getOverflowPosition()

getOverflowPosition(
   contentSize, 
   horizontalAlign, 
   row, 
   column, 
   columnCount): IColumnRange

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

Parameters

Parameter	Type
`contentSize`	`Required`<`ISize`>
`horizontalAlign`	`HorizontalAlign`
`row`	`number`
`column`	`number`
`columnCount`	`number`

Returns

IColumnRange

getRangeByBounding()

getRangeByBounding(bounds?): IRange

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

Parameters

Parameter	Type
`bounds`?	`IViewportInfo`

Returns

IRange

Deprecated

use getRangeByViewport instead.

getRangeByViewBound()

getRangeByViewBound(bound?): IRange

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

Parameters

Parameter	Type
`bound`?	`IBoundRectNoAngle`

Returns

IRange

getRangeByViewport()

getRangeByViewport(vpInfo?): IRange

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

Parameters

Parameter	Type
`vpInfo`?	`IViewportInfo`

Returns

IRange

getRowCount()

getRowCount(): number

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

Returns

number

getRowIndexByOffsetY()

getRowIndexByOffsetY(
   offsetY, 
   scaleY, 
   scrollXY, 
   options?): number

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

Parameters

Parameter	Type	Description
`offsetY`	`number`	scaled offset y
`scaleY`	`number`	scale y
`scrollXY`	{ `x`: `number`; `y`: `number`; }	-
`scrollXY.x`	`number`	-
`scrollXY.y`?	`number`	-
`options`?	`IGetRowColByPosOptions`	-

Returns

number

getRowPositionByOffsetY()

getRowPositionByOffsetY(
   offsetY, 
   scaleY, 
   scrollXY, 
   options?): number

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

Same as getRowIndexByOffsetY

Parameters

Parameter	Type
`offsetY`	`number`
`scaleY`	`number`
`scrollXY`	{ `x`: `number`; `y`: `number`; }
`scrollXY.x`	`number`
`scrollXY.y`?	`number`
`options`?	`IGetRowColByPosOptions`

Returns

number

Deprecated

Please use getRowIndexByOffsetY method instead.

getsStyles()

getsStyles(): Styles

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

Returns

Styles

Deprecated

should never expose a property that is provided by another module!

getTransformOffsetX()

getTransformOffsetX(
   offsetX, 
   scaleX, 
   scrollXY): number

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

Parameters

Parameter	Type
`offsetX`	`number`
`scaleX`	`number`
`scrollXY`	{ `x`: `number`; `y`: `number`; }
`scrollXY.x`	`number`
`scrollXY.y`	`number`

Returns

number

getTransformOffsetY()

getTransformOffsetY(
   offsetY, 
   scaleY, 
   scrollXY): number

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

Parameters

Parameter	Type
`offsetY`	`number`
`scaleY`	`number`
`scrollXY`	{ `x`: `number`; `y`: `number`; }
`scrollXY.x`	`number`
`scrollXY.y`	`number`

Returns

number

getVisibleRangeByViewport()

getVisibleRangeByViewport(viewportKey): undefined | IRowColumnRange

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

Parameters

Parameter	Type
`viewportKey`	`SHEET_VIEWPORT_KEY`

Returns

undefined | IRowColumnRange

getVisibleRanges()

getVisibleRanges(): Map<SHEET_VIEWPORT_KEY, IRowColumnRange>

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

Returns

Map<SHEET_VIEWPORT_KEY, IRowColumnRange>

getWorksheetConfig()

getWorksheetConfig(): IWorksheetData

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

Returns

IWorksheetData

Deprecated

should never expose a property that is provided by another module!

intersectMergeRange()

intersectMergeRange(row, column): boolean

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

Parameters

Parameter	Type
`row`	`number`
`column`	`number`

Returns

boolean

makeDirty()

makeDirty(state): void

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

Parameters

Parameter	Type
`state`	`boolean`

Returns

void

Inherited from

Skeleton.makeDirty

resetCache()

resetCache(): void

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

Returns

void

setMarginLeft()

setMarginLeft(left): void

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

Parameters

Parameter	Type
`left`	`number`

Returns

void

setMarginTop()

setMarginTop(top): void

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

Parameters

Parameter	Type
`top`	`number`

Returns

void

setOverflowCache()

setOverflowCache(value): void

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

Parameters

Parameter	Type
`value`	`ObjectMatrix`<`IRange`>

Returns

void

setStylesCache()

setStylesCache(vpInfo?): Nullable<SpreadsheetSkeleton>

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

Set border background and font to this._stylesCache by visible range, which derives from bounds)

Parameters

Parameter	Type	Description
`vpInfo`?	`IViewportInfo`	viewBounds

Returns

Nullable<SpreadsheetSkeleton>

updateVisibleRange()

updateVisibleRange(vpInfo?): boolean

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

Get range in visible area (range in view bounds) and set into this._rowColumnSegment.

Parameters

Parameter	Type
`vpInfo`?	`IViewportInfo`

Returns

boolean

boolean

visibleRangeByViewportKey()

visibleRangeByViewportKey(viewportKey): Nullable<IRowColumnRange>

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

Get range needs to render.

Parameters

Parameter	Type
`viewportKey`	`SHEET_VIEWPORT_KEY`

Returns

Nullable<IRowColumnRange>

Spreadsheetrowheader Thinengine