@univerjs/engine-render v0.1.17 • Docs
Class: SpreadsheetSkeleton
Extends
Constructors
new SpreadsheetSkeleton()
new SpreadsheetSkeleton(
_worksheet,
_worksheetData,
_cellData,
_styles,
_localeService,
_contextService): SpreadsheetSkeleton
Parameters
Parameter | Type | Description |
---|---|---|
_worksheet | undefined | 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 | - |
Returns
Overrides
Defined in
Properties
Property | Modifier | Type | Default value | Inherited from | Defined in |
---|---|---|---|---|---|
_disposed | protected | boolean | false | Skeleton ._disposed | submodules/univer/packages/core/src/shared/lifecycle.ts:93 (opens in a new tab) |
_localService | readonly | LocaleService | undefined | Skeleton ._localService | submodules/univer/packages/engine-render/src/components/skeleton.ts:27 (opens in a new tab) |
Accessors
columnHeaderHeight
get columnHeaderHeight(): number
Returns
number
Defined in
columnHeaderHeightAndMarginTop
get columnHeaderHeightAndMarginTop(): number
Returns
number
Defined in
columnTotalWidth
get columnTotalWidth(): number
Returns
number
Defined in
columnWidthAccumulation
get columnWidthAccumulation(): number[]
Returns
number
[]
Defined in
dataMergeCache
get dataMergeCache(): IRange[]
Returns
IRange
[]
Defined in
dirty
get dirty(): boolean
Returns
boolean
Inherited from
Defined in
submodules/univer/packages/engine-render/src/components/skeleton.ts:33 (opens in a new tab)
mergeData
get mergeData(): IRange[]
Returns
IRange
[]
Defined in
overflowCache
get overflowCache(): ObjectMatrix<IRange>
Returns
Defined in
rowColumnSegment
get rowColumnSegment(): IRowColumnSegment
row col start & end range
Returns
IRowColumnSegment
Defined in
rowHeaderWidth
get rowHeaderWidth(): number
Returns
number
Defined in
rowHeaderWidthAndMarginLeft
get rowHeaderWidthAndMarginLeft(): number
Returns
number
Defined in
rowHeightAccumulation
get rowHeightAccumulation(): number[]
Returns
number
[]
Defined in
rowTotalHeight
get rowTotalHeight(): number
Returns
number
Defined in
showGridlines
get showGridlines(): BooleanNumber
Returns
Defined in
stylesCache
get stylesCache(): IStylesCache
Returns
Defined in
worksheet
get worksheet(): undefined | Worksheet
Returns
undefined
| Worksheet
Defined in
Methods
_getBounding()
protected _getBounding(
rowHeightAccumulation,
columnWidthAccumulation,
viewBound?): IRange
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
The range cell index of the canvas visible area
Defined in
appendToOverflowCache()
appendToOverflowCache(
row,
column,
startColumn,
endColumn): void
Parameters
Parameter | Type |
---|---|
row | number |
column | number |
startColumn | number |
endColumn | number |
Returns
void
Defined in
calculate()
calculate(bounds?): SpreadsheetSkeleton
Parameters
Parameter | Type |
---|---|
bounds ? | IViewportInfo |
Returns
Defined in
calculateAutoHeightInRange()
calculateAutoHeightInRange(ranges): IRowAutoHeightInfo[]
Parameters
Parameter | Type |
---|---|
ranges | Nullable <IRange []> |
Returns
Defined in
calculateCellIndexByPosition()
calculateCellIndexByPosition(
offsetX,
offsetY,
scaleX,
scaleY,
scrollXY): Nullable<ISelectionCellWithCoord>
Parameters
Parameter | Type | Description |
---|---|---|
offsetX | number | HTML coordinate system, mouse position x. |
offsetY | number | HTML coordinate system, mouse position y. |
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 | - |
Returns
Nullable
<ISelectionCellWithCoord
>
Selection data with coordinates
Defined in
calculateSegment()
calculateSegment(bounds?): undefined | true
Parameters
Parameter | Type |
---|---|
bounds ? | IViewportInfo |
Returns
undefined
| true
Defined in
calculateWithoutClearingCache()
calculateWithoutClearingCache(bounds?): undefined | SpreadsheetSkeleton
Parameters
Parameter | Type |
---|---|
bounds ? | IViewportInfo |
Returns
undefined
| SpreadsheetSkeleton
Defined in
convertTransformToOffsetX()
convertTransformToOffsetX(
offsetX,
scaleX,
scrollXY): number
Parameters
Parameter | Type |
---|---|
offsetX | number |
scaleX | number |
scrollXY | object |
scrollXY.x | number |
scrollXY.y | number |
Returns
number
Defined in
convertTransformToOffsetY()
convertTransformToOffsetY(
offsetY,
scaleY,
scrollXY): number
Parameters
Parameter | Type |
---|---|
offsetY | number |
scaleY | number |
scrollXY | object |
scrollXY.x | number |
scrollXY.y | number |
Returns
number
Defined in
dispose()
dispose(): void
TODO: DR-Univer, fix as unknown as
Returns
void
Overrides
Defined in
disposeWithMe()
protected disposeWithMe(disposable): IDisposable
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
IDisposable
Inherited from
Defined in
submodules/univer/packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)
ensureNotDisposed()
protected ensureNotDisposed(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)
getBlankCellDocumentModel()
getBlankCellDocumentModel(cell): IDocumentLayoutObject
Parameters
Parameter | Type |
---|---|
cell | Nullable <ICellData > |
Returns
Defined in
getCellByIndex()
getCellByIndex(row, column): ISelectionCellWithCoord
Return cell information corresponding to the current coordinates, including the merged cell object.
Parameters
Parameter | Type | Description |
---|---|---|
row | number | Specified Row Coordinate |
column | number | Specified Column Coordinate |
Returns
Defined in
getCellByIndexWithNoHeader()
getCellByIndexWithNoHeader(row, column): {
actualColumn: column;
actualRow: row;
endX: number;
endY: number;
isMerged: boolean;
isMergedMainCell: boolean;
mergeInfo: newMergeInfo;
startX: number;
startY: number;
}
Parameters
Parameter | Type |
---|---|
row | number |
column | number |
Returns
{
actualColumn: column;
actualRow: row;
endX: number;
endY: number;
isMerged: boolean;
isMergedMainCell: boolean;
mergeInfo: newMergeInfo;
startX: number;
startY: number;
}
Defined in
getCellData()
getCellData(): ObjectMatrix<Nullable<ICellData>>
Returns
ObjectMatrix
<Nullable
<ICellData
>>
Deprecated
should never expose a property that is provided by another module!
Defined in
getCellDocumentModelWithFormula()
getCellDocumentModelWithFormula(cell): Nullable<IDocumentLayoutObject>
Parameters
Parameter | Type |
---|---|
cell | ICellData |
Returns
Nullable
<IDocumentLayoutObject
>
Defined in
getCellPositionByOffset()
getCellPositionByOffset(
offsetX,
offsetY,
scaleX,
scaleY,
scrollXY,
closeFirst?): {
column: number;
row: number;
}
Parameters
Parameter | Type | Description |
---|---|---|
offsetX | number | HTML coordinate system, mouse position x. |
offsetY | number | HTML coordinate system, mouse position y. |
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 | - |
closeFirst ? | boolean | - |
Returns
{
column: number;
row: number;
}
Hit cell coordinates
Defined in
getColumnCount()
getColumnCount(): number
Returns
number
Defined in
getColumnPositionByOffsetX()
getColumnPositionByOffsetX(
offsetX,
scaleX,
scrollXY,
closeFirst?): number
Parameters
Parameter | Type | Description |
---|---|---|
offsetX | number | scaled offset x |
scaleX | number | scale x |
scrollXY | object | - |
scrollXY.x | number | - |
scrollXY.y ? | number | - |
closeFirst ? | boolean | - |
Returns
number
Defined in
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;
}
Defined in
getFontLocale()
getFontLocale(): IFontLocale
Returns
Inherited from
Defined in
submodules/univer/packages/engine-render/src/components/skeleton.ts:37 (opens in a new tab)
getMergeBounding()
getMergeBounding(
startRow,
startColumn,
endRow,
endColumn): {
endColumn: number;
endRow: number;
startColumn: number;
startRow: number;
}
Parameters
Parameter | Type |
---|---|
startRow | number |
startColumn | number |
endRow | number |
endColumn | number |
Returns
{
endColumn: number;
endRow: number;
startColumn: number;
startRow: number;
}
Defined in
getNoMergeCellPositionByIndex()
getNoMergeCellPositionByIndex(rowIndex, columnIndex): {
endX: number;
endY: number;
startX: number;
startY: number;
}
Parameters
Parameter | Type |
---|---|
rowIndex | number |
columnIndex | number |
Returns
{
endX: number;
endY: number;
startX: number;
startY: number;
}
Defined in
getNoMergeCellPositionByIndexWithNoHeader()
getNoMergeCellPositionByIndexWithNoHeader(rowIndex, columnIndex): {
endX: number;
endY: number;
startX: number;
startY: number;
}
Parameters
Parameter | Type |
---|---|
rowIndex | number |
columnIndex | number |
Returns
{
endX: number;
endY: number;
startX: number;
startY: number;
}
Defined in
getOffsetByPositionX()
getOffsetByPositionX(column): number
Parameters
Parameter | Type |
---|---|
column | number |
Returns
number
Defined in
getOffsetByPositionY()
getOffsetByPositionY(row): number
Parameters
Parameter | Type |
---|---|
row | number |
Returns
number
Defined in
getOverflowPosition()
getOverflowPosition(
contentSize,
horizontalAlign,
row,
column,
columnCount): {
endColumn: number;
startColumn: number;
}
Parameters
Parameter | Type |
---|---|
contentSize | object |
contentSize.height | number |
contentSize.width | number |
horizontalAlign | HorizontalAlign |
row | number |
column | number |
columnCount | number |
Returns
{
endColumn: number;
startColumn: number;
}
Defined in
getRowColumnSegment()
getRowColumnSegment(bounds?): IRange
Parameters
Parameter | Type |
---|---|
bounds ? | IViewportInfo |
Returns
Defined in
getRowColumnSegmentByViewBound()
getRowColumnSegmentByViewBound(bound?): IRange
Parameters
Parameter | Type |
---|---|
bound ? | IBoundRectNoAngle |
Returns
Defined in
getRowCount()
getRowCount(): number
Returns
number
Defined in
getRowPositionByOffsetY()
getRowPositionByOffsetY(
offsetY,
scaleY,
scrollXY,
closeFirst?): number
Parameters
Parameter | Type | Description |
---|---|---|
offsetY | number | scaled offset y |
scaleY | number | scale y |
scrollXY | object | - |
scrollXY.x | number | - |
scrollXY.y ? | number | - |
closeFirst ? | boolean | - |
Returns
number
Defined in
getSelectionBounding()
getSelectionBounding(
startRow,
startColumn,
endRow,
endColumn): {
endColumn: number;
endRow: number;
startColumn: number;
startRow: number;
}
Parameters
Parameter | Type |
---|---|
startRow | number |
startColumn | number |
endRow | number |
endColumn | number |
Returns
{
endColumn: number;
endRow: number;
startColumn: number;
startRow: number;
}
Defined in
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
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
getWorksheetConfig()
getWorksheetConfig(): IWorksheetData
Returns
Deprecated
should never expose a property that is provided by another module!
Defined in
getsStyles()
getsStyles(): Styles
Returns
Deprecated
should never expose a property that is provided by another module!
Defined in
intersectMergeRange()
intersectMergeRange(row, column): boolean
Parameters
Parameter | Type |
---|---|
row | number |
column | number |
Returns
boolean
Defined in
makeDirty()
makeDirty(state): void
Parameters
Parameter | Type |
---|---|
state | boolean |
Returns
void
Inherited from
Defined in
submodules/univer/packages/engine-render/src/components/skeleton.ts:41 (opens in a new tab)
setMarginLeft()
setMarginLeft(left): void
Parameters
Parameter | Type |
---|---|
left | number |
Returns
void
Defined in
setMarginTop()
setMarginTop(top): void
Parameters
Parameter | Type |
---|---|
top | number |
Returns
void
Defined in
setOverflowCache()
setOverflowCache(value): void
Parameters
Parameter | Type |
---|---|
value | ObjectMatrix <IRange > |
Returns
void
Defined in
create()
static create(
worksheet,
config,
cellData,
styles,
localeService,
contextService): SpreadsheetSkeleton
Parameters
Parameter | Type |
---|---|
worksheet | undefined | Worksheet |
config | IWorksheetData |
cellData | ObjectMatrix <Nullable <ICellData >> |
styles | Styles |
localeService | LocaleService |
contextService | IContextService |