@univerjs/engine-render 0.5.1 → 0.5.2

package/lib/types/basics/tools.d.ts

@@ -127,14 +127,12 @@ export declare function inViewRanges(ranges: IRange[], rowIndex: number, colInde
  * 在非下方区域中
  * @param ranges
  * @param rowIndex
- * @returns
  */
 export declare function inCurrentAndAboveViewRanges(ranges: IRange[], rowIndex: number): boolean;
 /**
  * row 在任意一个 Range 中
  * @param ranges
  * @param rowIndex
- * @returns
  */
 export declare function inRowViewRanges(ranges: IRange[], rowIndex: number): boolean;
 /**

package/lib/types/canvas.d.ts

@@ -50,7 +50,13 @@ export declare class Canvas {
     getWidth(): number;
     getHeight(): number;
     setId(id: string): void;
-    setSize(width?: number, height?: number, pixelRatioParam?: number): void;
+    /**
+     * Resize canvas when width or height or devicePixelRatio changed.
+     * @param width
+     * @param height
+     * @param devicePixelRatio
+     */
+    setSize(width?: number, height?: number, devicePixelRatio?: number): void;
     setPixelRatio(pixelRatio: number): void;
     dispose(): void;
     clear(): void;

package/lib/types/components/sheets/index.d.ts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 export * from './column-header';
+export * from './constants';
 export * from './extensions';
 export * from './interfaces';
 export * from './row-header';

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

@@ -1,5 +1,5 @@
 import { ICellData, ICellDataForSheetInterceptor, ICellInfo, ICellWithCoord, IColAutoWidthInfo, IColumnRange, IPaddingData, IPosition, IRange, IRowAutoHeightInfo, IRowRange, ISize, IStyleData, ITextRotation, IWorksheetData, Nullable, Styles, VerticalAlign, Worksheet, BooleanNumber, DocumentDataModel, HorizontalAlign, IConfigService, IContextService, ImageCacheMap, Injector, LocaleService, ObjectMatrix, WrapStrategy } from '@univerjs/core';
-import { IBoundRectNoAngle, IViewportInfo } from '../../basics/vector2';
+import { IBoundRectNoAngle, IPoint, IViewportInfo } from '../../basics/vector2';
 import { DocumentSkeleton } from '../docs/layout/doc-skeleton';
 import { Skeleton } from '../skeleton';
 import { IFontCacheItem, IStylesCache, SHEET_VIEWPORT_KEY } from './interfaces';
@@ -51,12 +51,6 @@ export interface IGetPosByRowColOptions {
 }
 export declare class SpreadsheetSkeleton extends Skeleton {
     readonly worksheet: Worksheet;
-    /**
-     * @deprecated avoid use `IWorksheetData` directly, use API provided by `Worksheet`, otherwise
-     * `ViewModel` will be not working.
-     */
-    private _worksheetData;
-    private _cellData;
     private _styles;
     private readonly _contextService;
     private readonly _configService;
@@ -71,7 +65,8 @@ export declare class SpreadsheetSkeleton extends Skeleton {
      * Range viewBounds. only update by viewBounds.
      * It would change multiple times in one frame if there is multiple viewport (after freeze row&col)
      */
-    private _visibleRange;
+    private _drawingRange;
+    private _cacheRangeMap;
     private _visibleRangeMap;
     private _overflowCache;
     private _stylesCache;
@@ -80,6 +75,7 @@ export declare class SpreadsheetSkeleton extends Skeleton {
     private _handleBorderMatrix;
     private _handleFontMatrix;
     private _showGridlines;
+    private _gridlinesColor;
     private _marginTop;
     private _marginLeft;
     private _imageCacheMap;
@@ -88,12 +84,13 @@ export declare class SpreadsheetSkeleton extends Skeleton {
      */
     private _isRowStylePrecedeColumnStyle;
     private _renderRawFormula;
-    constructor(worksheet: Worksheet, 
     /**
      * @deprecated avoid use `IWorksheetData` directly, use API provided by `Worksheet`, otherwise
      * `ViewModel` will be not working.
      */
-    _worksheetData: IWorksheetData, _cellData: ObjectMatrix<Nullable<ICellData>>, _styles: Styles, _localeService: LocaleService, _contextService: IContextService, _configService: IConfigService, _injector: Injector);
+    private _worksheetData;
+    private _cellData;
+    constructor(worksheet: Worksheet, _styles: Styles, _localeService: LocaleService, _contextService: IContextService, _configService: IConfigService, _injector: Injector);
     get rowHeightAccumulation(): number[];
     get rowTotalHeight(): number;
     get columnWidthAccumulation(): number[];
@@ -105,10 +102,16 @@ export declare class SpreadsheetSkeleton extends Skeleton {
      * Range of visible area(range in viewBounds)
      */
     get rowColumnSegment(): IRowColumnRange;
+    /**
+     * Get range needs to render.
+     * @param viewportKey
+     * @returns
+     */
     visibleRangeByViewportKey(viewportKey: SHEET_VIEWPORT_KEY): Nullable<IRowColumnRange>;
     get stylesCache(): IStylesCache;
     get overflowCache(): ObjectMatrix<IRange>;
     get showGridlines(): BooleanNumber;
+    get gridlinesColor(): string | undefined;
     get mergeData(): IRange[];
     get rowHeaderWidthAndMarginLeft(): number;
     get columnHeaderHeightAndMarginTop(): number;
@@ -128,17 +131,23 @@ export declare class SpreadsheetSkeleton extends Skeleton {
     setMarginTop(top: number): void;
     getFont(rowIndex: number, columnIndex: number): Nullable<IFontCacheItem>;
     /**
-     * Get range in visible area (range in viewbounds) and set into this._rowColumnSegment.
-     * @param bounds
+     * Get range in visible area (range in view bounds) and set into this._rowColumnSegment.
+     * @param vpInfo
      * @returns boolean
      */
-    updateVisibleRange(bounds?: IViewportInfo): boolean;
+    updateVisibleRange(vpInfo?: IViewportInfo): boolean;
+    getVisibleRangeByViewport(viewportKey: SHEET_VIEWPORT_KEY): IRowColumnRange | undefined;
+    getVisibleRanges(): Map<SHEET_VIEWPORT_KEY, IRowColumnRange>;
     /**
      * Set border background and font to this._stylesCache by visible range, which derives from bounds)
-     * @param bounds viewBounds
+     * @param vpInfo viewBounds
      */
-    setStylesCache(bounds?: IViewportInfo): Nullable<SpreadsheetSkeleton>;
-    calculate(bounds?: IViewportInfo): Nullable<SpreadsheetSkeleton>;
+    setStylesCache(vpInfo?: IViewportInfo): Nullable<SpreadsheetSkeleton>;
+    /**
+     * Refresh cache after markDirty by SheetSkeletonManagerService.reCalculate()
+     * @param bounds
+     */
+    calculate(): Nullable<SpreadsheetSkeleton>;
     private _hasUnMergedCellInRow;
     /**
      * Calc all auto height by getDocsSkeletonPageSize in ranges
@@ -162,17 +171,25 @@ export declare class SpreadsheetSkeleton extends Skeleton {
      */
     _getMeasuredWidthByCell(cell: ICellDataForSheetInterceptor, currColWidth: number): number;
     /**
-     * Calculate data for row col & cell position, then update position value to this._rowHeaderWidth & this._rowHeightAccumulation & this._columnHeaderHeight & this._columnWidthAccumulation.
+     * Calculate data for row col & cell position.
+     * This method should be called whenever a sheet is dirty.
+     * Update position value to this._rowHeaderWidth & this._rowHeightAccumulation & this._columnHeaderHeight & this._columnWidthAccumulation.
      */
     private _updateLayout;
     private _dynamicallyUpdateRowHeaderWidth;
+    /**
+     * @deprecated use `getRangeByViewport` instead.
+     * @param bounds
+     */
     getRangeByBounding(bounds?: IViewportInfo): IRange;
+    getRangeByViewport(vpInfo?: IViewportInfo): IRange;
+    getCacheRangeByViewport(vpInfo?: IViewportInfo): IRange;
+    getRangeByViewBound(bound?: IBoundRectNoAngle): IRange;
     /**
      * @deprecated should never expose a property that is provided by another module!
      * @returns
      */
     getWorksheetConfig(): IWorksheetData;
-    getRangeByViewBound(bound?: IBoundRectNoAngle): IRange;
     getMergeBounding(startRow: number, startColumn: number, endRow: number, endColumn: number): IRange;
     /**
      * expand curr range if it's intersect with merge range.
@@ -386,7 +403,7 @@ export declare class SpreadsheetSkeleton extends Skeleton {
     private _getOverflowBound;
     intersectMergeRange(row: number, column: number): boolean;
     /**
-     * get the current row and column segment visible merge data
+     * Get the current row and column segment visible merge data.
      * @returns {IRange} The visible merge data
      */
     getCurrentRowColumnSegmentMergeData(range?: IRange): IRange[];
@@ -425,5 +442,16 @@ export declare class SpreadsheetSkeleton extends Skeleton {
      * @returns {ISelectionCell} The cell info with merge data
      */
     private _getCellMergeInfo;
+    getDistanceFromTopLeft(row: number, col: number): IPoint;
+    /**
+     * Distance from top left to row
+     * @param row
+     */
+    private _offsetYToRow;
+    /**
+     * Distance from top left to col
+     * @param col
+     */
+    private _offsetXToCol;
 }
 export {};

package/lib/types/components/sheets/spreadsheet.d.ts

@@ -66,7 +66,7 @@ export declare class Spreadsheet extends SheetComponent {
      */
     makeDirty(state?: boolean): this;
     setDirtyArea(dirtyBounds: IBoundRectNoAngle[]): void;
-    renderByViewport(mainCtx: UniverRenderingContext2D, viewportInfo: IViewportInfo, spreadsheetSkeleton: SpreadsheetSkeleton): void;
+    renderByViewports(mainCtx: UniverRenderingContext2D, viewportInfo: IViewportInfo, spreadsheetSkeleton: SpreadsheetSkeleton): void;
     paintNewAreaForScrolling(viewportInfo: IViewportInfo, param: IPaintForScrolling): void;
     /**
      * Redraw the entire viewport.
@@ -100,7 +100,6 @@ export declare class Spreadsheet extends SheetComponent {
      * Clear the guide lines within a range in the table, to make room for merged cells and overflow.
      */
     private _clearRectangle;
-    private _clearBackground;
     testShowRuler(cacheCtx: UniverRenderingContext2D, viewportInfo: IViewportInfo): void;
     testGetRandomLightColor(): string;
 }

package/lib/types/engine.d.ts

@@ -103,6 +103,7 @@ export declare class Engine extends Disposable {
     getPixelRatio(): number;
     setContainer(elem: HTMLElement, resize?: boolean): void;
     resize(): void;
+    dprChange(): void;
     /**
      * set canvas element size
      * @param width

package/lib/types/viewport.d.ts

@@ -5,6 +5,7 @@ import { IBoundRectNoAngle, IViewportInfo, Vector2 } from './basics/vector2';
 import { UniverRenderingContext } from './context';
 import { Scene } from './scene';
 import { BaseScrollBar } from './shape/base-scroll-bar';
+import { Subject } from 'rxjs';
 import { Transform } from './basics/transform';
 import { Canvas as UniverCanvas } from './canvas';
 interface ILimitedScrollResult {
@@ -63,7 +64,18 @@ interface IViewportScrollPosition {
     viewportScrollX: number;
     viewportScrollY: number;
 }
+export interface IViewportReSizeParam {
+    width: number;
+    height: number;
+    left: number;
+    top: number;
+    paddingStartX?: number;
+    paddingStartY?: number;
+    paddingEndX?: number;
+    paddingEndY?: number;
+}
 export declare class Viewport {
+    private _viewportKey;
     /**
      * scrollX means scroll x value for scrollbar in viewMain
      * use getBarScroll to get scrolling value(scrollX, scrollY) for scrollbar
@@ -96,7 +108,7 @@ export declare class Viewport {
     onScrollAfter$: EventSubject<IScrollObserverParam>;
     onScrollEnd$: EventSubject<IScrollObserverParam>;
     onScrollByBar$: EventSubject<IScrollObserverParam>;
-    private _viewportKey;
+    onResized$: Subject<IViewportReSizeParam>;
     /**
      * viewport top origin value in logic, scale does not affect it.
      */
@@ -122,28 +134,13 @@ export declare class Viewport {
     private _scrollStopNum;
     private _clipViewport;
     private _active;
-    private _paddingStartX;
     /**
-     * after create a freeze column, there is a "padding distace" from row header to curr viewport.
+     * after create a freeze column & row, there is a "padding distance" from row header to curr viewport.
      */
+    private _paddingStartX;
     private _paddingEndX;
-    /**
-     * after create a freeze row, there is a "padding distace" from column header to curr viewport.
-     */
     private _paddingStartY;
     private _paddingEndY;
-    /**
-     * Usually for viewport by after freeze, _explicitViewportWidthSet true means viewport's width is specify explicitly.
-     * ex: ViewMainLeft _explicitViewportWidthSet is true when freeze at a certain col, the width of viewMainLeft is decided by freeze line.
-     * Usually this prop is false for viewMain, viewport width is decided by engine size - freeze line
-     */
-    private _explicitViewportWidthSet;
-    /**
-     * _explicitViewportHeightSet true means viewport's height is specify explicitly.
-     * Used for viewport by after freeze.
-     * ex: ViewMainTop _explicitViewportHeightSet is true when freeze at a certain row, the height of viewMainTop is decided by freeze line.
-     */
-    private _explicitViewportHeightSet;
     /**
      * viewbound of cache area, cache area is slightly bigger than viewbound.
      */
@@ -157,9 +154,12 @@ export declare class Viewport {
     private _preViewBound;
     /**
      *  Whether the viewport needs to be updated.
-     *  In future, viewMain dirty would not affect othew viewports.
+     *  In future, viewMain dirty would not affect other viewports.
      */
     private _isDirty;
+    /**
+     * Canvas for cache if allowCache is true.
+     */
     private _cacheCanvas;
     /**
      * The configuration comes from the props.allowCache passed in during viewport initialization.
@@ -237,7 +237,7 @@ export declare class Viewport {
         isLimitedY: boolean;
     } | undefined;
     /**
-     * Srolling by current position plus delta.
+     * Scrolling by current position plus delta.
      * the most common case is triggered by scroll-timer(in sheet)
      * @param delta
      * @returns isLimited
@@ -281,7 +281,7 @@ export declare class Viewport {
     getScrollBar(): Nullable<BaseScrollBar>;
     /**
      * Just record state of scroll. This method won't scroll viewport and scrollbar.
-     * TODO: @lumixraku this method is so wierd, viewportMain did not call it, now only called in freeze situation.
+     * TODO: @lumixraku this method is so wried, viewportMain did not call it, now only called in freeze situation.
      * @param current
      * @returns Viewport
      */
@@ -296,7 +296,11 @@ export declare class Viewport {
      */
     render(parentCtx?: UniverRenderingContext, objects?: BaseObject[], isMaxLayer?: boolean): void;
     private _makeDefaultViewport;
-    private _calcViewportInfo;
+    calcViewportInfo(): IViewportInfo;
+    /**
+     * Get viewport info
+     * @deprecated use `calcViewportInfo`
+     */
     getBounding(): IViewportInfo;
     /**
      * convert vector to scene coordinate, include row & col
@@ -384,10 +388,5 @@ export declare class Viewport {
     private _calcDiffCacheBound;
     private _drawScrollbar;
     private _setViewportSize;
-    /**
-     * main canvas element resize
-     * called by this.scene.getEngine()?.onTransformChange$.add
-     */
-    private _mainCanvasResizeHandler;
 }
 export {};