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

Class: SpreadsheetSkeleton

Extends

Skeleton

Constructors

new SpreadsheetSkeleton()

new SpreadsheetSkeleton(
   worksheet, 
   _worksheetData, 
   _cellData, 
   _styles, 
   _localeService, 
   _contextService, 
   _configService): SpreadsheetSkeleton

Parameters

Parameter	Type	Description
`worksheet`	`Worksheet`	-
`_worksheetData`	`IWorksheetData`	Deprecated avoid use `IWorksheetData` directly, use API provided by `Worksheet`, otherwise `ViewModel` will be not working.
`_cellData`	`ObjectMatrix`<`Nullable`<`ICellData`>>	-
`_styles`	`Styles`	-
`_localeService`	`LocaleService`	-
`_contextService`	`IContextService`	-
`_configService`	`IConfigService`	-

Returns

SpreadsheetSkeleton

Overrides

Skeleton.constructor

Defined in

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

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:93
`_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:253

Accessors

columnHeaderHeight

Get Signature

get columnHeaderHeight(): number

Returns

number

Defined in

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

columnHeaderHeightAndMarginTop

Get Signature

get columnHeaderHeightAndMarginTop(): number

Returns

number

Defined in

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

columnTotalWidth

Get Signature

get columnTotalWidth(): number

Returns

number

Defined in

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

columnWidthAccumulation

Get Signature

get columnWidthAccumulation(): number[]

Returns

number[]

Defined in

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

dirty

Get Signature

get dirty(): boolean

Returns

boolean

Inherited from

Skeleton.dirty

Defined in

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

mergeData

Get Signature

get mergeData(): IRange[]

Returns

IRange[]

Defined in

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

overflowCache

Get Signature

get overflowCache(): ObjectMatrix<IRange>

Returns

ObjectMatrix<IRange>

Defined in

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

rowColumnSegment

Get Signature

get rowColumnSegment(): IRowColumnRange

Range of visible area(range in viewBounds)

Returns

IRowColumnRange

Defined in

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

rowHeaderWidth

Get Signature

get rowHeaderWidth(): number

Returns

number

Defined in

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

rowHeaderWidthAndMarginLeft

Get Signature

get rowHeaderWidthAndMarginLeft(): number

Returns

number

Defined in

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

rowHeightAccumulation

Get Signature

get rowHeightAccumulation(): number[]

Returns

number[]

Defined in

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

rowTotalHeight

Get Signature

get rowTotalHeight(): number

Returns

number

Defined in

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

showGridlines

Get Signature

get showGridlines(): BooleanNumber

Returns

BooleanNumber

Defined in

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

stylesCache

Get Signature

get stylesCache(): IStylesCache

Returns

IStylesCache

Defined in

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

Methods

_getMeasuredWidthByCell()

_getMeasuredWidthByCell(cell, currColWidth): number

For _calculateColMaxWidth

Parameters

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

Returns

number

width

Defined in

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

_getRangeByViewBounding()

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

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

Defined in

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

_setBgStylesCache()

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

Parameters

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

Returns

void

Defined in

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

_setBorderStylesCache()

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

Parameters

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

Returns

void

Defined in

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

_setFontStylesCache()

_setFontStylesCache(
   row, 
   col, 
   cell): void

Parameters

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

Returns

void

Defined in

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

appendToOverflowCache()

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

Parameters

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

Returns

void

Defined in

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

calculate()

calculate(bounds?): Nullable<SpreadsheetSkeleton>

Parameters

Parameter	Type
`bounds`?	`IViewportInfo`

Returns

Nullable<SpreadsheetSkeleton>

Defined in

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

calculateAutoHeightInRange()

calculateAutoHeightInRange(ranges): IRowAutoHeightInfo[]

Calc all auto height by getDocsSkeletonPageSize in ranges

Parameters

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

Returns

IRowAutoHeightInfo[]

result

Defined in

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

calculateAutoWidthInRange()

calculateAutoWidthInRange(ranges): IColAutoWidthInfo[]

Parameters

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

Returns

IColAutoWidthInfo[]

Defined in

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

calculateCellIndexByPosition()

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

Get cell by pos(offsetX, offsetY).

Parameters

Parameter	Type
`offsetX`	`number`
`offsetY`	`number`
`scaleX`	`number`
`scaleY`	`number`
`scrollXY`	`object`
`scrollXY.x`	`number`
`scrollXY.y`	`number`

Returns

Nullable<ICellWithCoord>

Deprecated

Please use getCellWithCoordByOffset instead.

Defined in

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

convertTransformToOffsetX()

convertTransformToOffsetX(
   offsetX, 
   scaleX, 
   scrollXY): number

convert canvas content position to physical position in screen

Parameters

Parameter	Type
`offsetX`	`number`
`scaleX`	`number`
`scrollXY`	`object`
`scrollXY.x`	`number`
`scrollXY.y`	`number`

Returns

number

Defined in

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

convertTransformToOffsetY()

convertTransformToOffsetY(
   offsetY, 
   scaleY, 
   scrollXY): number

convert canvas content position to physical position in screen

Parameters

Parameter	Type
`offsetY`	`number`
`scaleY`	`number`
`scrollXY`	`object`
`scrollXY.x`	`number`
`scrollXY.y`	`number`

Returns

number

Defined in

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

dispose()

dispose(): void

Returns

void

Overrides

Skeleton.dispose

Defined in

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

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Skeleton.disposeWithMe

Defined in

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

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Skeleton.ensureNotDisposed

Defined in

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

expandRangeByMerge()

expandRangeByMerge(range): IRange

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

Parameters

Parameter	Type
`range`	`IRange`

Returns

IRange

expanded range because merge info.

Defined in

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

getBlankCellDocumentModel()

getBlankCellDocumentModel(cell): IDocumentLayoutObject

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.

Defined in

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

getCellByIndex()

getCellByIndex(row, column): ICellWithCoord

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.

Defined in

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

getCellByIndexWithNoHeader()

getCellByIndexWithNoHeader(row, column): ICellWithCoord

Parameters

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

Returns

ICellWithCoord

Deprecated

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

Defined in

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

getCellByOffset()

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

Parameters

Parameter	Type
`offsetX`	`number`
`offsetY`	`number`
`scaleX`	`number`
`scaleY`	`number`
`scrollXY`	`object`
`scrollXY.x`	`number`
`scrollXY.y`	`number`

Returns

Nullable<ICellInfo>

Defined in

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

getCellDocumentModelWithFormula()

getCellDocumentModelWithFormula(cell): Nullable<IDocumentLayoutObject>

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.

Defined in

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

getCellIndexByOffset()

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

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`	`object`	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:1129
`row`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-skeleton.ts:1129

Defined in

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

getCellPositionByOffset()

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

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`	`object`
`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:1107
`row`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-skeleton.ts:1107

Deprecated

Please use getCellIndexByOffset method instead.

Defined in

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

getCellWithCoordByIndex()

getCellWithCoordByIndex(
   row, 
   column, 
   header): ICellWithCoord

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

Defined in

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

getCellWithCoordByOffset()

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

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`	`object`	render viewportScroll {x, y}
`scrollXY.x`	`number`	-
`scrollXY.y`?	`number`	-
`options`?	`IGetRowColByPosOptions`	{IGetRowColByPosOptions}

Returns

ICellWithCoord

Selection data with coordinates

Defined in

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

getCellWithMergeInfoByIndex()

getCellWithMergeInfoByIndex(row, column): Nullable<ICellInfo>

Parameters

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

Returns

Nullable<ICellInfo>

Defined in

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

getColumnCount()

getColumnCount(): number

Returns

number

Defined in

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

getColumnIndexByOffsetX()

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

Get column index by offset x.

Parameters

Parameter	Type	Description
`evtOffsetX`	`number`	-
`scaleX`	`number`	scale x
`scrollXY`	`object`	scrollXY
`scrollXY.x`	`number`	-
`scrollXY.y`?	`number`	-
`options`?	`IGetRowColByPosOptions`	-

Returns

number

column index

Defined in

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

getColumnPositionByOffsetX()

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

Same as getColumnIndexByOffsetX

Parameters

Parameter	Type
`offsetX`	`number`
`scaleX`	`number`
`scrollXY`	`object`
`scrollXY.x`	`number`
`scrollXY.y`?	`number`
`options`?	`IGetRowColByPosOptions`

Returns

number

Deprecated

Please use getColumnIndexByOffsetX method instead.

Defined in

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

getCurrentRowColumnSegmentMergeData()

getCurrentRowColumnSegmentMergeData(range?): IRange[]

get the current row and column segment visible merge data

Parameters

Parameter	Type
`range`?	`IRange`

Returns

IRange[]

The visible merge data

Defined in

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

getDecomposedOffset()

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

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:1529
`columnOffset`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-skeleton.ts:1529
`row`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-skeleton.ts:1529
`rowOffset`	`number`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/components/sheets/sheet-skeleton.ts:1529

Defined in

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

getFont()

getFont(rowIndex, columnIndex): Nullable<IFontCacheItem>

Parameters

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

Returns

Nullable<IFontCacheItem>

Defined in

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

getFontLocale()

getFontLocale(): IFontLocale

Returns

IFontLocale

Inherited from

Skeleton.getFontLocale

Defined in

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

getLocation()

getLocation(): [string, string]

Get which Workbook and Worksheet this skeleton is attached to.

Returns

[string, string]

[unitId, sheetId]

Defined in

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

getMergeBounding()

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

Parameters

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

Returns

IRange

Defined in

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

getNoMergeCellPositionByIndex()

getNoMergeCellPositionByIndex(rowIndex, columnIndex): IPosition

Parameters

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

Returns

IPosition

Defined in

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

getNoMergeCellPositionByIndexWithNoHeader()

getNoMergeCellPositionByIndexWithNoHeader(rowIndex, columnIndex): IPosition

Parameters

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

Returns

IPosition

Defined in

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

getOffsetByPositionX()

getOffsetByPositionX(column): number

Parameters

Parameter	Type
`column`	`number`

Returns

number

Defined in

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

getOffsetByPositionY()

getOffsetByPositionY(row): number

Parameters

Parameter	Type
`row`	`number`

Returns

number

Defined in

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

getOverflowPosition()

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

Parameters

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

Returns

IColumnRange

Defined in

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

getRangeByBounding()

getRangeByBounding(bounds?): IRange

Parameters

Parameter	Type
`bounds`?	`IViewportInfo`

Returns

IRange

Defined in

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

getRangeByViewBound()

getRangeByViewBound(bound?): IRange

Parameters

Parameter	Type
`bound`?	`IBoundRectNoAngle`

Returns

IRange

Defined in

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

getRowCount()

getRowCount(): number

Returns

number

Defined in

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

getRowIndexByOffsetY()

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

Parameters

Parameter	Type	Description
`offsetY`	`number`	scaled offset y
`scaleY`	`number`	scale y
`scrollXY`	`object`	-
`scrollXY.x`	`number`	-
`scrollXY.y`?	`number`	-
`options`?	`IGetRowColByPosOptions`	-

Returns

number

Defined in

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

getRowPositionByOffsetY()

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

Same as getRowIndexByOffsetY

Parameters

Parameter	Type
`offsetY`	`number`
`scaleY`	`number`
`scrollXY`	`object`
`scrollXY.x`	`number`
`scrollXY.y`?	`number`
`options`?	`IGetRowColByPosOptions`

Returns

number

Deprecated

Please use getRowIndexByOffsetY method instead.

Defined in

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

getsStyles()

getsStyles(): Styles

Returns

Styles

Deprecated

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

Defined in

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

getTransformOffsetX()

getTransformOffsetX(
   offsetX, 
   scaleX, 
   scrollXY): number

Parameters

Parameter	Type
`offsetX`	`number`
`scaleX`	`number`
`scrollXY`	`object`
`scrollXY.x`	`number`
`scrollXY.y`	`number`

Returns

number

Defined in

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

getTransformOffsetY()

getTransformOffsetY(
   offsetY, 
   scaleY, 
   scrollXY): number

Parameters

Parameter	Type
`offsetY`	`number`
`scaleY`	`number`
`scrollXY`	`object`
`scrollXY.x`	`number`
`scrollXY.y`	`number`

Returns

number

Defined in

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

getWorksheetConfig()

getWorksheetConfig(): IWorksheetData

Returns

IWorksheetData

Deprecated

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

Defined in

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

intersectMergeRange()

intersectMergeRange(row, column): boolean

Parameters

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

Returns

boolean

Defined in

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

makeDirty()

makeDirty(state): void

Parameters

Parameter	Type
`state`	`boolean`

Returns

void

Inherited from

Skeleton.makeDirty

Defined in

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

resetCache()

resetCache(): void

Returns

void

Defined in

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

setMarginLeft()

setMarginLeft(left): void

Parameters

Parameter	Type
`left`	`number`

Returns

void

Defined in

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

setMarginTop()

setMarginTop(top): void

Parameters

Parameter	Type
`top`	`number`

Returns

void

Defined in

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

setOverflowCache()

setOverflowCache(value): void

Parameters

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

Returns

void

Defined in

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

setStylesCache()

setStylesCache(bounds?): Nullable<SpreadsheetSkeleton>

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

Parameters

Parameter	Type	Description
`bounds`?	`IViewportInfo`	viewBounds

Returns

Nullable<SpreadsheetSkeleton>

Defined in

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

updateVisibleRange()

updateVisibleRange(bounds?): boolean

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

Parameters

Parameter	Type
`bounds`?	`IViewportInfo`

Returns

boolean

boolean

Defined in

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

visibleRangeByViewportKey()

visibleRangeByViewportKey(viewportKey): Nullable<IRowColumnRange>

Parameters

Parameter	Type
`viewportKey`	`SHEET_VIEWPORT_KEY`

Returns

Nullable<IRowColumnRange>

Defined in

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

Spreadsheetrowheader Thinengine