@univerjs/core 0.19.0 → 0.20.0

package/lib/types/sheets/sheet-skeleton.d.ts

@@ -103,9 +103,6 @@ export declare class SheetSkeleton extends Skeleton {
     private _generateRowMatrixCache;
     /**
      * Calc columnWidthAccumulation by columnData
-     * @param colCount
-     * @param columnData
-     * @param defaultColumnWidth
      */
     private _generateColumnMatrixCache;
     intersectMergeRange(row: number, column: number): boolean;
@@ -118,7 +115,6 @@ export declare class SheetSkeleton extends Skeleton {
     protected _updateLayout(): void;
     /**
      * Refresh cache after markDirty by SheetSkeletonManagerService.reCalculate()
-     * @param bounds
      */
     calculate(): Nullable<SheetSkeleton>;
     resetRangeCache(_ranges: IRange[]): void;
@@ -126,7 +122,6 @@ export declare class SheetSkeleton extends Skeleton {
     protected _hasUnMergedCellInRow(rowIndex: number, startColumn: number, endColumn: number): boolean;
     /**
      * expand curr range if it's intersect with merge range.
-     * @param range
      * @returns {IRange} expanded range because merge info.
      */
     expandRangeByMerge(range: IRange, inRefSelectionMode?: boolean): IRange;
@@ -134,38 +129,15 @@ export declare class SheetSkeleton extends Skeleton {
     getRowCount(): number;
     /**
      * New version to get merge data.
-     * @param row
-     * @param column
      * @returns {ISelectionCell} The cell info with merge data
      */
     protected _getCellMergeInfo(row: number, column: number): ISelectionCell;
-    /**
-     * @deprecated use getNoMergeCellWithCoordByIndex instead.
-     * @param rowIndex
-     * @param columnIndex
-     * @param header
-     * @returns
-     */
-    getNoMergeCellPositionByIndex(rowIndex: number, columnIndex: number, header?: boolean): IPosition;
     /**
      * Original name: getNoMergeCellPositionByIndex
-     * @param rowIndex
-     * @param columnIndex
      */
     getNoMergeCellWithCoordByIndex(rowIndex: number, columnIndex: number, header?: boolean): IPosition;
     /**
-     * @deprecated use getNoMergeCellWithCoordByIndex(row, col, false)
-     * @param rowIndex
-     * @param columnIndex
-     */
-    getNoMergeCellPositionByIndexWithNoHeader(rowIndex: number, columnIndex: number): IPosition;
-    /**
-     *
-     * @param offsetY scaled offset y
-     * @param scaleY scale y
-     * @param scrollXY
-     * @param scrollXY.x
-     * @param scrollXY.y
+     * Get row index by offset y.
      */
     getRowIndexByOffsetY(offsetY: number, scaleY: number, scrollXY: {
         x: number;
@@ -173,10 +145,6 @@ export declare class SheetSkeleton extends Skeleton {
     }, options?: IGetRowColByPosOptions): number;
     /**
      * Get column index by offset x.
-     * @param offsetX scaled offset x
-     * @param scaleX scale x
-     * @param scrollXY scrollXY
-     * @returns column index
      */
     getColumnIndexByOffsetX(evtOffsetX: number, scaleX: number, scrollXY: {
         x: number;
@@ -191,7 +159,6 @@ export declare class SheetSkeleton extends Skeleton {
      * @param scrollXY  render viewport scroll {x, y}, scene.getScrollXYByRelativeCoords, scene.getScrollXY
      * @param scrollXY.x
      * @param scrollXY.y
-     * @returns {row, col}
      */
     getCellIndexByOffset(offsetX: number, offsetY: number, scaleX: number, scaleY: number, scrollXY: {
         x: number;
@@ -202,11 +169,6 @@ export declare class SheetSkeleton extends Skeleton {
     };
     /**
      * Unlike getCellWithCoordByOffset, returning data doesn't include coord.
-     * @param offsetX
-     * @param offsetY
-     * @param scaleX
-     * @param scaleY
-     * @param scrollXY
      */
     getCellByOffset(offsetX: number, offsetY: number, scaleX: number, scaleY: number, scrollXY: {
         x: number;
@@ -214,7 +176,6 @@ export declare class SheetSkeleton extends Skeleton {
     }): Nullable<ICellInfo>;
     /**
      * Return cell information corresponding to the current coordinates, including the merged cell object.
-     *
      * @param row Specified Row Coordinate
      * @param column Specified Column Coordinate
      */
@@ -237,19 +198,15 @@ export declare class SheetSkeleton extends Skeleton {
     }, options?: IGetRowColByPosOptions): ICellWithCoord;
     /**
      * Original name: getOffsetByPositionX
-     * @param column
-     * @returns
      */
     getOffsetByColumn(column: number): number;
     /**
      * Original name: getOffsetByPositionY
-     * @param row
      */
     getOffsetByRow(row: number): number;
     /**
      * Original name: getDecomposedOffset
-     * @param offsetX
-     * @param offsetY
+     * Here, offsetX and offsetY are the coordinates in the main viewport, excluding the rowHeaderWidthAndMarginLeft and columnHeaderHeightAndMarginTop.
      */
     getOffsetRelativeToRowCol(offsetX: number, offsetY: number): {
         row: number;
@@ -257,6 +214,15 @@ export declare class SheetSkeleton extends Skeleton {
         columnOffset: number;
         rowOffset: number;
     };
+    /**
+     * Here, offsetX and offsetY are the coordinates in the viewport, including the rowHeaderWidthAndMarginLeft and columnHeaderHeightAndMarginTop.
+     */
+    getCellIndexAndOffsetByPosition(offsetX: number, offsetY: number): {
+        row: number;
+        rowOffset: number;
+        column: number;
+        columnOffset: number;
+    };
     protected _updateConfigAndGetDocumentModel(documentData: IDocumentData, horizontalAlign: HorizontalAlign, paddingData: IPaddingData, renderConfig?: IDocumentRenderConfig): Nullable<DocumentDataModel>;
     dispose(): void;
 }
@@ -269,15 +235,6 @@ export declare class SheetSkeleton extends Skeleton {
  * @param columnWidthAccumulation
  */
 export declare function getCellCoordByIndexSimple(row: number, column: number, rowHeightAccumulation: number[], columnWidthAccumulation: number[]): IPosition;
-/**
- * @deprecated use `getCellCoordByIndexSimple` instead.
- * @param row
- * @param column
- * @param rowHeightAccumulation
- * @param columnWidthAccumulation
- * @returns
- */
-export declare function getCellPositionByIndexSimple(row: number, column: number, rowHeightAccumulation: number[], columnWidthAccumulation: number[]): IPosition;
 /**
  * @description Get the cell position information of the specified row and column, including the position of the cell and the merge info
  * @param {number} row The row index of the cell