@univerjs-pro/engine-shape 0.15.3-insiders.20260131-cbd5fac

package/lib/types/render-engine/shape-render-model.d.ts

@@ -0,0 +1,96 @@
+import { IGdContext, IGdContextKey, IPresetShapeConfig, IShapeData, IShapeGdContextKeyPoint, IShapeHitTestResult, IShapeRect, IShapeRenderParameters } from '../shape-type';
+import { BaseShapeContext } from './base-shape-context';
+export declare abstract class BaseShapeRenderModel {
+    protected _isLineShape: boolean;
+    abstract readonly name: string;
+    abstract readonly presetShapeConfig: IPresetShapeConfig;
+    private _inverseCache;
+    isLineShape(): boolean;
+    getConnectorLinePoints(): IShapeGdContextKeyPoint[];
+    /**
+     * This method tests whether a point (pointX, pointY) hits any interactive parts of the shape,
+     * such as connection points or adjustment handles.
+     * The point coordinates are in the shape's local coordinate system.
+     * @param {number} pointX The x-coordinate of the point to test.
+     * @param {number} pointY The y-coordinate of the point to test.
+     * @param {BaseShapeContext} shapeContext
+     * @returns {IShapeHitTestResult} The result of the hit test.
+     */
+    hitTest(pointX: number, pointY: number, shapeContext: BaseShapeContext): IShapeHitTestResult;
+    /**
+     * Get the text rectangle within the shape
+     * @param rect current drawing object rect
+     * @param gdRecord The current gdRecord used to calculate text rect, if the shape has transformed, should use the latest gdRecord
+     * @returns {IShapeRect} The text rectangle within the shape
+     */
+    getTextRect(rect: IShapeRect, gdRecord: Partial<IGdContext>): IShapeRect;
+    /**
+     * 使用 Canvas API 渲染形状
+     */
+    render(canvasContext: CanvasRenderingContext2D, rect: IShapeRect, shapeContext: BaseShapeContext, shapeData: IShapeData, renderOption: IShapeRenderParameters): void;
+    private _getDashType;
+    private _getCapType;
+    private _getJoinType;
+    private _getStrokeWidth;
+    /**
+     * Create a gradient based on the shape's fill configuration
+     * @param canvasContext The canvas rendering context
+     * @param rect The shape rectangle (note: we're already translated to rect.left, rect.top)
+     * @param shapeData The shape data containing gradient configuration
+     * @returns CanvasGradient or null if gradient cannot be created
+     */
+    private _createGradient;
+    /**
+     * Create a linear gradient
+     */
+    private _createLinearGradient;
+    /**
+     * Create a radial gradient (center to edges)
+     */
+    private _createRadialGradient;
+    /**
+     * Create an angular (conic) gradient
+     * Since Canvas 2D doesn't have native conic gradient, we create a radial approximation
+     * or use createConicGradient if available (modern browsers)
+     */
+    private _createAngularGradient;
+    /**
+     * Create a diamond gradient
+     * This is approximated using a radial gradient with adjusted parameters
+     */
+    private _createDiamondGradient;
+    /**
+     * Add color stops to a gradient
+     */
+    private _addGradientStops;
+    private _getFillStyle;
+    private _getStrokeStyle;
+    private _renderTextBox;
+    private _renderCxnPoints;
+    private _getValueFromGdRecord;
+    /**
+     * Check if the adjust handle at the given index has an inverse relationship.
+     * Uses cache to avoid recalculating.
+     * @param index The index of the adjust handle in ahLst
+     * @returns true if inverse relationship exists
+     */
+    isInverse(index: number): boolean;
+    /**
+     * Detect if there's an inverse relationship between adj value and position.
+     * Analyzes the gd formula chain to find subtract patterns like "r - adj*k" or "b - adj*k".
+     * @param adjustInfo The adjust handle info
+     * @returns true if inverse relationship is detected
+     */
+    private _detectInverseRelationship;
+    /**
+     * Recursively analyze gd formula to detect inverse relationship.
+     * Looking for patterns like: pos = r - f(adj) or pos = b - f(adj)
+     */
+    private _analyzeFormulaForInverse;
+    /**
+     * Check if a gd variable depends on (is derived from) adjName
+     */
+    private _dependsOnAdj;
+    getGdValue(key: number | IGdContextKey, gdRecord: Partial<IGdContext>): number;
+    private _renderAdjustHandles;
+}

package/lib/types/shape-default.d.ts

@@ -0,0 +1,27 @@
+import { ShapeLineCapEnum, ShapeLineDashEnum, ShapeLineJoinEnum } from './shape-enum';
+export declare const ShapeDefaultConfig: {
+    fill: string;
+    stroke: string;
+    strokeWidth: number;
+    cxnPointRadius: number;
+    cxnPointFill: string;
+    cxnPointStroke: string;
+    cxnPointStrokeWidth: number;
+    adjHandleSize: number;
+    adjHandleFill: string;
+    adjHandleStroke: string;
+    adjHandleStrokeWidth: number;
+    lineDashType: ShapeLineDashEnum;
+    lineCapType: ShapeLineCapEnum;
+    lineJoinType: ShapeLineJoinEnum;
+    shapeText: {
+        padding: number;
+        fontSize: number;
+        fontFamily: string;
+        color: string;
+        isRichText: boolean;
+        bold: boolean;
+        italic: boolean;
+        underline: boolean;
+    };
+};

package/lib/types/shape-enum.d.ts

@@ -0,0 +1,314 @@
+/**
+ * Basic shape types
+ */
+export declare enum BasicShapeEnum {
+    /**
+     * Basic Shape
+     */
+    BasicShape = 1,
+    /**
+     * Connect Shape, such as straight connector, bent connector, curved connector
+     */
+    ConnectShape = 2,
+    /**
+     * Group Shape
+     */
+    GroupShape = 3
+}
+/**
+ * Shape render mode enum
+ * For example, Path, Connection Point, Adjustment Point
+ */
+export declare enum ShapeRenderModeEnum {
+    Path = 2,
+    Cxn = 4,
+    Adj = 8
+}
+export declare enum ShapeDirectionEnum {
+    Right = 0,
+    Down = 90,
+    Left = 180,
+    Up = 270
+}
+export declare enum ShapeFillEnum {
+    NoFill = 1,
+    SolidFil = 2,
+    GradientFill = 3,
+    PatternFill = 4,
+    PictureFill = 5
+}
+export declare enum ShapeGradientTypeEnum {
+    Linear = 1,
+    Radial = 2,
+    Angular = 3,
+    Diamond = 4
+}
+/**
+ * Shape line type enum
+ * This enum is used to define the line fill type (no line, solid, gradient)
+ */
+export declare enum ShapeLineTypeEnum {
+    NoLine = 1,
+    SolidLine = 2,
+    GradientLine = 3
+}
+/**
+ * Shape operator enum, it used to define the shape geometry
+ */
+export declare enum ShapeOperatorEnum {
+    Val = "val",
+    Pin = "pin",
+    AddSub = "addSub",
+    MulDiv = "mulDiv",
+    AddDiv = "addDiv",
+    Abs = "abs",
+    Max = "max",
+    Min = "min",
+    IfElse = "ifelse",
+    Sin = "sin",
+    Cos = "cos",
+    Tan = "tan",
+    Atan2 = "at2",
+    Mod = "mod",
+    Sqrt = "sqrt",
+    Cat2 = "cat2",
+    Sat2 = "sat2"
+}
+export declare enum ShapeTypeEnum {
+    None = "none",
+    Rect = "rect",
+    RoundRect = "roundRect",
+    Ellipse = "ellipse",
+    Diamond = "diamond",
+    Triangle = "triangle",
+    RightTriangle = "rtTriangle",
+    Parallelogram = "parallelogram",
+    Trapezoid = "trapezoid",
+    Hexagon = "hexagon",// 这个跟Heptagon 不一样的点在于调节点
+    Octagon = "octagon",
+    Plus = "plus",
+    Star5 = "star5",
+    Star6 = "star6",
+    Star7 = "star7",
+    Star8 = "star8",
+    Star10 = "star10",
+    Star12 = "star12",
+    Star16 = "star16",
+    Star24 = "star24",
+    Star32 = "star32",
+    Round1Rect = "round1Rect",
+    Round2SameRect = "round2SameRect",
+    Round2DiagRect = "round2DiagRect",
+    Snip1Rect = "snip1Rect",
+    SnipRoundRect = "snipRoundRect",
+    Snip2SameRect = "snip2SameRect",
+    Snip2DiagRect = "snip2DiagRect",
+    Plaque = "plaque",
+    Frame = "frame",
+    HalfFrame = "halfFrame",
+    Corner = "corner",
+    DiagStripe = "diagStripe",
+    Chord = "chord",
+    Arc = "arc",
+    LeftCircularArrow = "leftCircularArrow",
+    LeftRightCircularArrow = "leftRightCircularArrow",
+    SwooshArrow = "swooshArrow",
+    LeftRightRibbon = "leftRightRibbon",
+    TextBox = "textBox",
+    Circle = "circle",// 特例 圆形其实是椭圆的一种，只不过限定了长宽相等 excel没有circle这个形状，只有ellipse
+    Heptagon = "heptagon",
+    HomePlate = "homePlate",
+    RightArrow = "rightArrow",
+    LeftArrow = "leftArrow",
+    UpArrow = "upArrow",
+    DownArrow = "downArrow",
+    LeftRightArrow = "leftRightArrow",
+    UpDownArrow = "upDownArrow",
+    QuadArrow = "quadArrow",
+    LeftRightUpArrow = "leftRightUpArrow",
+    BentArrow = "bentArrow",
+    UturnArrow = "uturnArrow",
+    LeftUpArrow = "leftUpArrow",
+    BentUpArrow = "bentUpArrow",
+    CurvedRightArrow = "curvedRightArrow",
+    CurvedLeftArrow = "curvedLeftArrow",
+    CurvedUpArrow = "curvedUpArrow",
+    CurvedDownArrow = "curvedDownArrow",
+    StripedRightArrow = "stripedRightArrow",
+    NotchedRightArrow = "notchedRightArrow",
+    Pentagon = "pentagon",
+    Chevron = "chevron",
+    RightArrowCallout = "rightArrowCallout",
+    DownArrowCallout = "downArrowCallout",
+    LeftArrowCallout = "leftArrowCallout",
+    UpArrowCallout = "upArrowCallout",
+    LeftRightArrowCallout = "leftRightArrowCallout",
+    QuadArrowCallout = "quadArrowCallout",
+    CircularArrow = "circularArrow",
+    MathPlus = "mathPlus",
+    MathMinus = "mathMinus",
+    MathMultiply = "mathMultiply",
+    MathDivide = "mathDivide",
+    MathEqual = "mathEqual",
+    MathNotEqual = "mathNotEqual",
+    FlowchartProcess = "flowChartProcess",
+    FlowchartAlternateProcess = "flowChartAlternateProcess",
+    FlowchartDecision = "flowChartDecision",
+    FlowChartInputOutput = "flowChartInputOutput",
+    FlowchartPredefinedProcess = "flowChartPredefinedProcess",
+    FlowchartInternalStorage = "flowChartInternalStorage",
+    FlowchartDocument = "flowChartDocument",
+    FlowchartMultiDocument = "flowChartMultidocument",
+    FlowchartTerminator = "flowChartTerminator",
+    FlowchartPreparation = "flowChartPreparation",
+    FlowchartManualInput = "flowChartManualInput",
+    FlowchartManualOperation = "flowChartManualOperation",
+    FlowchartConnector = "flowChartConnector",
+    FlowchartOffPageConnector = "flowChartOffpageConnector",
+    FlowchartPunchedCard = "flowChartPunchedCard",
+    FlowchartPunchedTape = "flowChartPunchedTape",
+    FlowchartSummingJunction = "flowChartSummingJunction",
+    FlowchartOr = "flowChartOr",
+    FlowchartCollate = "flowChartCollate",
+    FlowchartSort = "flowChartSort",
+    FlowchartExtract = "flowChartExtract",
+    FlowchartMerge = "flowChartMerge",
+    FlowchartOnlineStorage = "flowChartOnlineStorage",
+    FlowchartDelay = "flowChartDelay",
+    FlowchartMagneticTape = "flowChartMagneticTape",
+    FlowchartMagneticDisk = "flowChartMagneticDisk",
+    FlowchartMagneticDrum = "flowChartMagneticDrum",
+    FlowchartDisplay = "flowChartDisplay",
+    WedgeRectCallout = "wedgeRectCallout",
+    WedgeRoundRectCallout = "wedgeRoundRectCallout",
+    WedgeEllipseCallout = "wedgeEllipseCallout",
+    CloudCallout = "cloudCallout",
+    BorderCallout1 = "borderCallout1",
+    BorderCallout2 = "borderCallout2",
+    BorderCallout3 = "borderCallout3",
+    AccentCallout1 = "accentCallout1",
+    AccentCallout2 = "accentCallout2",
+    AccentCallout3 = "accentCallout3",
+    Callout1 = "callout1",
+    Callout2 = "callout2",
+    Callout3 = "callout3",
+    AccentBorderCallout1 = "accentBorderCallout1",
+    AccentBorderCallout2 = "accentBorderCallout2",
+    AccentBorderCallout3 = "accentBorderCallout3",
+    Ribbon = "ribbon",
+    Ribbon2 = "ribbon2",
+    EllipseRibbon = "ellipseRibbon",
+    EllipseRibbon2 = "ellipseRibbon2",
+    VerticalScroll = "verticalScroll",
+    HorizontalScroll = "horizontalScroll",
+    Wave = "wave",
+    DoubleWave = "doubleWave",
+    Cube = "cube",
+    Can = "can",
+    LightningBolt = "lightningBolt",
+    Heart = "heart",
+    Sun = "sun",
+    Moon = "moon",
+    SmileyFace = "smileyFace",
+    IrregularSeal1 = "irregularSeal1",
+    IrregularSeal2 = "irregularSeal2",
+    FoldedCorner = "folderCorner",
+    Bevel = "bevel",
+    Donut = "donut",
+    NoSmoking = "noSmoking",
+    BlockArc = "blockArc",
+    Teardrop = "teardrop",
+    PieWedge = "pieWedge",
+    Pie = "pie",
+    Funnel = "funnel",
+    Gear6 = "gear6",
+    Gear9 = "gear9",
+    Decagon = "decagon",
+    Dodecagon = "dodecagon",
+    CornerTabs = "cornerTabs",
+    LeftBrace = "leftBrace",
+    RightBrace = "rightBrace",
+    LeftBracket = "leftBracket",
+    RightBracket = "rightBracket",
+    ActionButtonBackPrevious = "actionButtonBackPrevious",
+    ActionButtonForwardNext = "actionButtonForwardNext",
+    ActionButtonBeginning = "actionButtonBeginning",
+    ActionButtonEnd = "actionButtonEnd",
+    ActionButtonHome = "actionButtonHome",
+    ActionButtonInformation = "actionButtonInformation",
+    ActionButtonReturn = "actionButtonReturn",
+    ActionButtonMovie = "actionButtonMovie",
+    ActionButtonDocument = "actionButtonDocument",
+    ActionButtonSound = "actionButtonSound",
+    ActionButtonHelp = "actionButtonHelp",
+    ActionButtonBlank = "actionButtonBlank",
+    BracePair = "bracePair",
+    BracketPair = "bracketPair",
+    ChartPlus = "chartPlus",
+    ChartStar = "chartStar",
+    ChartX = "chartX",
+    Cloud = "cloud",
+    FlowChartOfflineStorage = "flowChartOfflineStorage",
+    LineInv = "lineInv",
+    NonIsoscelesTrapezoid = "nonIsoscelesTrapezoid",
+    PlaqueTabs = "plaqueTabs",
+    SquareTabs = "squareTabs",
+    Star4 = "star4",
+    UpDownArrowCallout = "upDownArrowCallout",
+    Line = "line",
+    StraightConnector1 = "straightConnector1",
+    BentConnector2 = "bentConnector2",
+    BentConnector3 = "bentConnector3",
+    BentConnector4 = "bentConnector4",
+    BentConnector5 = "bentConnector5",
+    CurvedConnector2 = "curvedConnector2",
+    CurvedConnector3 = "curvedConnector3",
+    CurvedConnector4 = "curvedConnector4",
+    CurvedConnector5 = "curvedConnector5"
+}
+/**
+ * Shape line style enums
+ * This enum is used define basic shape stroke style or line shape stroke style
+ */
+export declare enum ShapeLineDashEnum {
+    Solid = 1,
+    RoundDot = 2,
+    SquareDot = 3,
+    Dash = 4,
+    DashDot = 5,
+    LongDash = 6,
+    LongDashDot = 7,
+    LongDashDotDot = 8
+}
+/**
+ * The line cap type of shape line style or basic shape line stroke style
+ */
+export declare enum ShapeLineCapEnum {
+    Flat = 1,
+    Round = 2,
+    Square = 3
+}
+/**
+ * The line join type of shape line style or basic shape line stroke style
+ */
+export declare enum ShapeLineJoinEnum {
+    Miter = 1,
+    Round = 2,
+    Bevel = 3
+}
+/**
+ * The arrow type of connector line shape
+ */
+export declare enum ShapeArrowTypeEnum {
+    None = 0,
+    Arrow = 1,
+    OpenArrow = 2,
+    DiamondArrow = 3,
+    StealthArrow = 4,
+    OvalArrow = 5
+}
+export declare enum ShapeArrowSizeEnum {
+    Small = 1,
+    Medium = 2,
+    Large = 3
+}