@logicflow/extension 2.0.0-beta.3 → 2.0.0-beta.4

package/lib/tools/snapshot/index.d.ts

@@ -1,25 +1,115 @@
+import LogicFlow from '@logicflow/core';
+export type ToImageOptions = {
+    /**
+     * 导出图片的格式，可选值为：`png`、`webp`、`gif`、`jpeg`、`svg`，默认值为 `png`
+     */
+    fileType?: string;
+    /**
+     * 导出图片的宽度，通常无需设置，设置后可能会拉伸图形
+     */
+    width?: number;
+    /**
+     * 导出图片的高度，通常无需设置，设置后可能会拉伸图形
+     */
+    height?: number;
+    /**
+     * 导出图片的背景色，默认为透明
+     */
+    backgroundColor?: string;
+    /**
+     * 导出图片的质量。
+     *
+     * 在指定图片格式为 `jpeg` 或 `webp` 的情况下，可以从 0 到 1 的区间内选择图片的质量，如果超出取值范围，将会使用默认值 0.92。导出为其他格式的图片时，该参数会被忽略。
+     */
+    quality?: number;
+    /**
+     * 导出图片的内边距，即元素内容所在区域边界与图片边界的距离，单位为像素，默认为 40
+     */
+    padding?: number;
+    /**
+     * 导出图片时是否开启局部渲染
+     * - `false`：将导出画布上所有的元素
+     * - `true`：只导出画面区域内的可见元素
+     */
+    partial?: boolean;
+};
+export type SnapshotResponse = {
+    data: Blob | string;
+    width: number;
+    height: number;
+};
 /**
  * 快照插件，生成视图
  */
 export declare class Snapshot {
     static pluginName: string;
-    lf: any;
+    lf: LogicFlow;
     offsetX?: number;
     offsetY?: number;
-    fileName: string;
+    fileName?: string;
     customCssRules: string;
     useGlobalRules: boolean;
     constructor({ lf }: {
         lf: any;
     });
-    getSvgRootElement(lf: any): any;
-    triggerDownload(imgURI: string): void;
-    removeAnchor(element: any): void;
-    removeRotateControl(element: any): void;
-    getSnapshot(fileName: string, backgroundColor: string): void;
-    getSnapshotBase64(backgroundColor: string): Promise<unknown>;
-    getSnapshotBlob(backgroundColor: string): Promise<unknown>;
-    getClassRules(): string;
-    getCanvasData(svg: SVGGraphicsElement, backgroundColor: string): Promise<any>;
+    /**
+     * 获取svgRoot对象dom: 画布元素（不包含grid背景）
+     * @param lf LogicFlow
+     * @returns
+     */
+    getSvgRootElement(lf: LogicFlow): Element;
+    /**
+     * 通过 imgUrl 下载图片
+     * @param imgUrl
+     */
+    triggerDownload(imgUrl: string): void;
+    /**
+     * 删除锚点
+     * @param element ChildNode
+     */
+    private removeAnchor;
+    /**
+     * 删除旋转按钮
+     * @param element
+     */
+    private removeRotateControl;
+    /**
+     * 下载图片
+     * @param fileName string
+     * @param toImageOptions
+     */
+    private getSnapshot;
+    /**
+     * 获取base64对象
+     * @param backgroundColor string | undefined
+     * @param fileType string | undefined
+     * @returns Promise<SnapshotResponse>
+     */
+    private getSnapshotBase64;
+    /**
+     * 获取Blob对象
+     * @param backgroundColor string | undefined
+     * @param fileType string | undefined
+     * @returns
+     */
+    private getSnapshotBlob;
+    /**
+     * 获取脚本css样式
+     * @returns rules string
+     */
+    private getClassRules;
+    /**
+     * 获取图片生成中间产物canvas对象，用户转换为其他需要的格式
+     * @param svg Element
+     * @param toImageOptions ToImageOptions
+     * @returns Promise<HTMLCanvasElement>
+     */
+    private getCanvasData;
+    /**
+     * 克隆并处理画布节点
+     * @param svg Node
+     * @returns
+     */
+    private cloneSvg;
 }
 export default Snapshot;