WebCAD-Lib-TS API 文档 - v1.0.0
    Preparing search index...

    Interface ISaveWebcadPatchParams

    保存 WebCAD Patch 参数

    interface ISaveWebcadPatchParams {
        type: "imports" | "designs";
        designPath?: string;
        branchName?: string;
        patch?: string;
        vcadData?: string;
        parentId?: string;
        drawingName?: string;
        author?: string;
        remark?: string;
        conflictResolution?: Record<
            string,
            { choice: "server"
            | "client"; entityData?: any },
        >;
        patchCompressed?: boolean;
        conflictResolutionCompressed?: boolean;
        editAreas?: IEditArea[];
        editLayers?: string[];
        tileAlpha?: number;
    }
    Index

    Properties

    type: "imports" | "designs"

    图纸类型

    designPath?: string

    设计图路径 (designs 类型)

    branchName?: string

    分支名称,默认 "main"

    patch?: string

    Patch 数据 (JSON 字符串,用于更新已有图纸)

    vcadData?: string

    完整 vcad 数据 (JSON 字符串,用于创建新图纸)

    parentId?: string

    父级 Patch ID (用于冲突检测,默认 "base")

    drawingName?: string

    图纸名称

    author?: string

    作者

    remark?: string

    备注

    conflictResolution?: Record<
        string,
        { choice: "server"
        | "client"; entityData?: any },
    >

    冲突解决方案(新格式,支持传递实体数据) 格式: { entityId: { choice: "server" | "client", entityData?: ... } }

    • choice: "server": 采用服务器版本
    • choice: "client": 采用客户端版本,entityData 包含实体完整数据(用于恢复被删除的实体)
    patchCompressed?: boolean

    patch 是否已压缩 (gzip + base64) 当 patch 数据长度超过阈值时,会自动压缩以减少传输量

    conflictResolutionCompressed?: boolean

    conflictResolution 是否已压缩 (gzip + base64) 当冲突解决数据较大时,会自动压缩以减少传输量

    editAreas?: IEditArea[]

    瓦片编辑区域列表 记录瓦片模式下的编辑区域,用于下次打开时恢复

    editLayers?: string[]

    编辑图层名称列表 记录瓦片模式下的编辑图层,用于下次打开时恢复

    tileAlpha?: number

    瓦片图层透明度(0-1) 瓦片模式下保存瓦片图层的透明度设置