@univerjs/engine-render 1.0.0-alpha.8 → 1.0.0-beta.0

package/lib/types/alignment-snap.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export interface IAlignmentRect {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+}
+export type AlignmentSnapAxis = 'x' | 'y';
+export interface IAlignmentSnapGuide {
+    id: string;
+    axis: AlignmentSnapAxis;
+    position: number;
+}
+export interface IAlignmentSnapSessionConfig {
+    enterThreshold?: number;
+    exitThreshold?: number;
+    breakawayThreshold?: number;
+    softThreshold?: number;
+    hardThreshold?: number;
+    softMaxStrength?: number;
+    cooldownMs?: number;
+}
+export interface IAlignmentSnapAxisOptions {
+    axis: AlignmentSnapAxis;
+    value: number;
+    guide: IAlignmentSnapGuide | null;
+    now?: number;
+}
+export interface IAlignmentSnapAxisResult {
+    snapped: boolean;
+    value: number;
+    guide: IAlignmentSnapGuide | null;
+}
+export declare function normalizeAlignmentRect(rect: IAlignmentRect): IAlignmentRect;
+export declare function getAlignmentRectXAnchors(rect: IAlignmentRect): [number, number, number];
+export declare function getAlignmentRectYAnchors(rect: IAlignmentRect): [number, number, number];
+export declare function getClosestAlignmentOffset(activeAnchors: readonly number[], targetAnchors: readonly number[], threshold: number): number;
+export declare class AlignmentSnapSession {
+    private readonly _enterThreshold;
+    private readonly _exitThreshold;
+    private readonly _breakawayThreshold;
+    private readonly _softThreshold;
+    private readonly _hardThreshold;
+    private readonly _softMaxStrength;
+    private readonly _cooldownMs;
+    private _activeGuideId;
+    private _activeGuideStartValue;
+    private _releasedUntil;
+    constructor(config?: IAlignmentSnapSessionConfig);
+    reset(): void;
+    resolveAxisSnap(options: IAlignmentSnapAxisOptions): IAlignmentSnapAxisResult;
+    private _resolveSnappedValue;
+}

package/lib/types/base-object.d.ts

@@ -164,6 +164,14 @@ export declare abstract class BaseObject extends Disposable {
     isRender(bounds?: IViewportInfo): boolean | undefined;
     getParent(): any;
     getState(): ITransformState;
+    /**
+     * Returns the flip state after composing this object with every ancestor
+     * drawing group whose transform participates in rendering.
+     */
+    getEffectiveFlipState(): {
+        flipX: boolean;
+        flipY: boolean;
+    };
     getRealBound(): IGroupBaseBound;
     hide(): void;
     show(): void;

package/lib/types/basics/drawing-effect.d.ts

@@ -13,8 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import type { IGlowEffect, IShadowEffect } from '@univerjs/core';
 import type { IBoundRectNoAngle } from './vector2';
-import { type IGlowEffect, type IShadowEffect } from '@univerjs/core';
 export interface IResolvedDrawingShadow {
     color: string;
     blurRadius: number;

package/lib/types/basics/i-document-skeleton-cached.d.ts

@@ -209,6 +209,7 @@ export interface IDocumentSkeletonGlyph {
     url?: string;
     featureId?: string;
     drawingId?: string;
+    fauxBoldStrokeWidth?: number;
 }
 export interface IDocumentSkeletonBullet {
     listId: string;
@@ -216,9 +217,13 @@ export interface IDocumentSkeletonBullet {
     ts: ITextStyle;
     fontStyle?: IDocumentSkeletonFontStyle;
     startIndexItem: number;
+    startNumber?: number;
     nestingLevel?: INestingLevel;
     bulletAlign?: BulletAlignment;
     bulletType?: boolean;
+    compactSpacing?: boolean;
+    preserveTextLineHeight?: boolean;
+    imageSource?: string;
     paragraphProperties?: IParagraphProperties;
 }
 export interface IDocumentSkeletonDrawing {
@@ -241,6 +246,8 @@ export interface IDocumentSkeletonDrawing {
         contentHeight?: number;
         contentWidth?: number;
         height?: number;
+        pageContentWidth?: number;
+        viewScale?: number;
         viewportHeight?: number;
     };
 }

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

@@ -94,6 +94,15 @@ export interface IParagraphConfig {
     paragraphIndex: number;
     documentCompatibilityPolicy?: IDocumentCompatibilityPolicy;
     useWordStyleLineHeight?: boolean;
+    usePptxFontSizeLineHeight?: boolean;
+    usePptxNominalFontLineHeight?: boolean;
+    usePptxCompatibleLineSpacing?: boolean;
+    usePptxPercentageLineSpacing?: boolean;
+    pptxPercentageFontSize?: number;
+    usePptxNormAutofitLineHeight?: boolean;
+    pptxEmptyParagraphFontSize?: number;
+    pptxHasExplicitEndParaFontSize?: boolean;
+    sumPptxParagraphSpacing?: boolean;
     docxFallbackAnchorLeft?: IParagraphStyle['indentStart'];
     paragraphNonInlineSkeDrawings?: Map<string, IDocumentSkeletonDrawing>;
     paragraphInlineSkeDrawings?: Map<string, IDocumentSkeletonDrawing>;

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

@@ -16,6 +16,7 @@
 import type { IPosition, IRange, IRangeWithCoord, IScale, IStyleBase, Nullable } from '@univerjs/core';
 import type { IDocumentSkeletonFontStyle } from './i-document-skeleton-cached';
 import type { IBoundRectNoAngle } from './vector2';
+export declare function hasScrollableOverflow(contentSize: number, viewportSize: number): boolean;
 export declare const getColor: (RgbArray: number[], opacity?: number) => string;
 export declare const toPx: (num: number | string, ReferenceValue: Nullable<number>) => number;
 /**

package/lib/types/components/docs/custom-block-render-viewport.d.ts

@@ -29,6 +29,8 @@ export interface IDocsCustomBlockRenderViewport {
     height: number;
     layoutWidth?: number;
     offsetLeft?: number;
+    pageContentWidth?: number;
+    viewScale?: number;
     viewportHeight?: number;
     width: number;
 }

package/lib/types/components/docs/extensions/line.d.ts

@@ -15,17 +15,21 @@
  */
 import type { IScale } from '@univerjs/core';
 import type { IDocumentSkeletonGlyph } from '../../../basics/i-document-skeleton-cached';
+import type { IBoundRectNoAngle } from '../../../basics/vector2';
 import type { UniverRenderingContext } from '../../../context';
+import type { IDrawInfo } from '../../extension';
 import { docExtension } from '../doc-extension';
 export declare class Line extends docExtension {
     uKey: string;
     Z_INDEX: number;
     private _preBackgroundColor;
-    draw(ctx: UniverRenderingContext, parentScale: IScale, glyph: IDocumentSkeletonGlyph): void;
+    draw(ctx: UniverRenderingContext, parentScale: IScale, glyph: IDocumentSkeletonGlyph, _diff?: IBoundRectNoAngle, more?: IDrawInfo): void;
     clearCache(): void;
     private _drawLine;
     private _drawLineTo;
     private _setLineType;
     private _isWave;
     private _isDouble;
+    private _isAccounting;
+    private _isFirstAccountingGlyph;
 }

package/lib/types/components/docs/layout/block/paragraph/bullet.d.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IBullet, ILists, LocaleService, Nullable } from '@univerjs/core';
+import type { IBullet, ILists, ITextStyle, LocaleService, Nullable } from '@univerjs/core';
 import type { IDocumentSkeletonBullet } from '../../../../../basics/i-document-skeleton-cached';
-export declare function dealWithBullet(bullet?: IBullet, lists?: ILists, listLevelAncestors?: Array<Nullable<IDocumentSkeletonBullet>>, localeService?: LocaleService): IDocumentSkeletonBullet | undefined;
+export declare function dealWithBullet(bullet?: IBullet, lists?: ILists, listLevelAncestors?: Array<Nullable<IDocumentSkeletonBullet>>, localeService?: LocaleService, compactSpacing?: boolean, paragraphTextStyle?: ITextStyle): IDocumentSkeletonBullet | undefined;
 export declare function getDefaultBulletSke(listId: string, startIndex?: number): IDocumentSkeletonBullet;

package/lib/types/components/docs/layout/block/paragraph/layout-ruler.d.ts

@@ -18,7 +18,7 @@ import type { IParagraphConfig, IParagraphTableCache, ISectionBreakConfig } from
 import type { IFloatObject, ILayoutContext } from '../../tools';
 import { BooleanNumber, GridType, SpacingRule } from '@univerjs/core';
 import { BreakPointType } from '../../line-breaker/break';
-declare function isGlyphGroupBeyondDivideWidth(glyphGroup: IDocumentSkeletonGlyph[], offsetLeft: number, divideWidth: number): boolean;
+declare function isGlyphGroupBeyondDivideWidth(glyphGroup: IDocumentSkeletonGlyph[], offsetLeft: number, divideWidth: number, hangingPunctuation?: boolean): boolean;
 export declare function layoutParagraph(ctx: ILayoutContext, glyphGroup: IDocumentSkeletonGlyph[], pages: IDocumentSkeletonPage[], sectionBreakConfig: ISectionBreakConfig, paragraphConfig: IParagraphConfig, isParagraphFirstShapedText: boolean, breakPointType?: BreakPointType): IDocumentSkeletonPage[];
 declare function __avoidFlowAffectingDrawingsForTable(table: IDocumentSkeletonTable, page: IDocumentSkeletonPage, column: IDocumentSkeletonColumn): void;
 declare function _updateAndPositionTable(ctx: ILayoutContext, lineTop: number, lineHeight: number, page: IDocumentSkeletonPage, column: IDocumentSkeletonColumn, section: IDocumentSkeletonSection, skeTablesInParagraph: IParagraphTableCache[], paragraphIndex: number, sectionBreakConfig: ISectionBreakConfig, drawingAnchorTop?: number): boolean;

package/lib/types/components/docs/layout/doc-no-wrap-measure.d.ts

@@ -27,6 +27,11 @@ export declare function measureDocumentNoWrapTextRangeWidth(documentData: IDocum
  * details such as CJK-Latin spacing.
  */
 export declare function measureDocumentNoWrapTextWidth(documentData: IDocumentData | null | undefined): number;
+/**
+ * Measures the widest line after applying the docs Unicode break policy
+ * within a fixed-width host.
+ */
+export declare function measureDocumentWrappedTextWidth(documentData: IDocumentData | null | undefined, maxLineWidth: number): number;
 /**
  * Measures the widest segment that docs line breaking keeps together. This is
  * useful when a host may wrap normally but still needs enough width to avoid

package/lib/types/{basics/unit-convert.d.ts → components/docs/layout/line-breaker/extensions/east-asian-quote-linebreak-extension.d.ts}

@@ -13,5 +13,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-declare const whiteListKeyForPt: Set<string>;
-declare function isNotEmpty(value: unknown): boolean;
+import type { LineBreaker } from '../line-breaker';
+export declare function eastAsianQuoteLineBreakExtension(breaker: LineBreaker): void;

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

@@ -21,4 +21,6 @@ export * from './row-header';
 export * from './sheet-component';
 export * from './sheet.render-skeleton';
 export * from './spreadsheet';
+export { calculateCellImageRect } from './util';
+export type { ICellImageRectConfig } from './util';
 export * from './watermark';

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

@@ -40,6 +40,7 @@ export declare const DEFAULT_PADDING_DATA: {
 };
 export declare const RENDER_RAW_FORMULA_KEY = "RENDER_RAW_FORMULA";
 export declare function getShrinkToFitScale(contentWidth: number, availableWidth: number, fontSize: number): number;
+export declare function getGeneralNumberDisplayText(value: number, displayText: string, fontString: string, availableWidth: number): string;
 export declare function scaleDocumentDataForShrinkToFit(documentData: IDocumentData, scale: number, fallbackFontSize: number): IDocumentData;
 export interface ICacheItem {
     bg: boolean;
@@ -177,6 +178,7 @@ export declare class SpreadsheetSkeleton extends SheetSkeleton {
     _setBorderStylesCache(row: number, col: number, style: Nullable<IStyleData>, options: ISetStylesCacheForOneCellOptions | undefined): void;
     _setBgStylesCache(row: number, col: number, style: Nullable<IStyleData>, options: ISetStylesCacheForOneCellOptions | undefined): void;
     private _applyShrinkToFit;
+    private _applyGeneralNumberDisplay;
     _setFontStylesCache(row: number, col: number, cellData: Nullable<ICellDataForSheetInterceptor>, style: IStyleData, hasMergeData?: boolean): void;
     /**
      * Set border background and font to this._stylesCache cell by cell.

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

@@ -48,7 +48,7 @@ export declare class Spreadsheet extends SheetComponent {
      * @param ctx
      * @param viewportInfo
      */
-    draw(ctx: UniverRenderingContext2D, viewportInfo: IViewportInfo): void;
+    draw(ctx: UniverRenderingContext2D, viewportInfo: IViewportInfo, isMergeRepair?: boolean): void;
     addRenderFrameTimeMetricToScene(timeKey: string, val: number, scene: Scene): void;
     addRenderTagToScene(renderKey: string, val: any, scene?: Scene): void;
     /**
@@ -77,7 +77,9 @@ export declare class Spreadsheet extends SheetComponent {
     makeDirty(state?: boolean): this;
     setDirtyArea(dirtyBounds: IBoundRectNoAngle[]): void;
     renderByViewports(mainCtx: UniverRenderingContext2D, viewportInfo: IViewportInfo, spreadsheetSkeleton: SpreadsheetSkeleton): void;
-    paintNewAreaForScrolling(viewportInfo: IViewportInfo, param: IPaintForScrolling): void;
+    private _getMergeRepairBounds;
+    private _getRepaintBounds;
+    paintNewAreaForScrolling(viewportInfo: IViewportInfo, param: IPaintForScrolling, mergeRepairBounds?: IBoundRectNoAngle[]): void;
     /**
      * Redraw the entire viewport.
      */

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

@@ -14,7 +14,17 @@
  * limitations under the License.
  */
 import type { CellValueType, IPaddingData, IStyleBase, IStyleData, ITextRotation, ITextStyle, Nullable, TextDirection } from '@univerjs/core';
+import type { IBoundRectNoAngle } from '../../basics';
 import { DocumentDataModel, HorizontalAlign, VerticalAlign, WrapStrategy } from '@univerjs/core';
+export interface ICellImageRectConfig {
+    cellRect: IBoundRectNoAngle;
+    imageWidth: number;
+    imageHeight: number;
+    horizontalAlign: HorizontalAlign;
+    verticalAlign: VerticalAlign;
+    padding?: Nullable<IPaddingData>;
+}
+export declare function calculateCellImageRect(config: ICellImageRectConfig): IBoundRectNoAngle;
 export interface ICellStyle {
     textRotation?: ITextRotation;
     textDirection?: Nullable<TextDirection>;

package/lib/types/drawing-group.d.ts

@@ -34,7 +34,7 @@ export declare class DrawingGroupObject extends Group {
      * When rendering, positions are mapped from baseBound space to the group's current transform.
      */
     private _baseBound;
-    private _outerShadow?;
+    protected _outerShadow?: IDrawingGroupShadow;
     private _glow?;
     setOuterShadow(shadow?: IDrawingGroupShadow): void;
     setGlow(glow?: IGlowEffect): void;

package/lib/types/index.d.ts

@@ -13,6 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+export { AlignmentSnapSession, getAlignmentRectXAnchors, getAlignmentRectYAnchors, getClosestAlignmentOffset, normalizeAlignmentRect, } from './alignment-snap';
+export type { AlignmentSnapAxis, IAlignmentRect, IAlignmentSnapAxisOptions, IAlignmentSnapAxisResult, IAlignmentSnapGuide, IAlignmentSnapSessionConfig, } from './alignment-snap';
 export * from './base-object';
 export * from './basics';
 export { combineDrawingEffectFilter, createDrawingEffectFilter, expandDrawingEffectBounds, resolveDrawingEffectMasks, resolveGlowEffect, resolveOuterShadowEffect, } from './basics/drawing-effect';
@@ -27,7 +29,7 @@ export { Documents } from './components/docs/document';
 export type { IPageRenderConfig } from './components/docs/document';
 export type { IDocumentOffsetConfig } from './components/docs/document';
 export { getTableIdAndSliceIndex } from './components/docs/layout/block/table';
-export { measureDocumentNoWrapTextRangeWidth, measureDocumentNoWrapTextWidth, measureDocumentUnbreakableTextWidth, } from './components/docs/layout/doc-no-wrap-measure';
+export { measureDocumentNoWrapTextRangeWidth, measureDocumentNoWrapTextWidth, measureDocumentUnbreakableTextWidth, measureDocumentWrappedTextWidth, } from './components/docs/layout/doc-no-wrap-measure';
 export * from './components/docs/layout/doc-simple-skeleton';
 export { DocumentSkeleton } from './components/docs/layout/doc-skeleton';
 export type { IFindNodeRestrictions } from './components/docs/layout/doc-skeleton';

package/lib/types/shape/scroll-bar.d.ts

@@ -43,14 +43,18 @@ export interface IScrollBarProps {
     enableHorizontal?: boolean;
     /** Enable the vertical scroll bar. True by default. */
     enableVertical?: boolean;
+    /** Hide the track when the corresponding content axis does not overflow. False by default. */
+    hideTrackWhenUnscrollable?: boolean;
     /** The min width of horizon thumb. Default is 17 px. */
     minThumbSizeH?: number;
     /** The min height of vertical thumb. Default is 17 px. */
     minThumbSizeV?: number;
 }
 export declare class ScrollBar extends Disposable {
+    static readonly DEFAULT_TOTAL_SIZE: number;
     _enableHorizontal: boolean;
     _enableVertical: boolean;
+    private _hideTrackWhenUnscrollable;
     horizontalThumbSize: number;
     horizontalMinusMiniThumb: number;
     horizontalTrackWidth: number;
@@ -109,6 +113,8 @@ export declare class ScrollBar extends Disposable {
     set enableHorizontal(val: boolean);
     get enableVertical(): boolean;
     set enableVertical(val: boolean);
+    get hideTrackWhenUnscrollable(): boolean;
+    set hideTrackWhenUnscrollable(val: boolean);
     get limitX(): number;
     get limitY(): number;
     get ratioScrollX(): number;