2.8.0-beta-4

imagepath hook

manifest-beta.json

@@ -1,7 +1,7 @@
 {
 	"id": "obsidian-excalidraw-plugin",
 	"name": "Excalidraw",
-	"version": "2.8.0-beta-3",
+	"version": "2.8.0-beta-4",
 	"minAppVersion": "1.1.6",
 	"description": "An Obsidian plugin to edit and view Excalidraw drawings",
 	"author": "Zsolt Viczian",

src/constants/assets/startupScript.md

@@ -105,6 +105,41 @@
  */
 //ea.onFileCreateHook = (data) => {}; 
 
+/**
+ * If set, this callback is triggered when a image is being saved in Excalidraw.
+ * You can use this callback to customize the naming and path of pasted images to avoid
+ * default names like "Pasted image 123147170.png" being saved in the attachments folder,
+ * and instead use more meaningful names based on the Excalidraw file or other criteria,
+ * plus save the image in a different folder.
+ * 
+ * If the function returns null or undefined, the normal Excalidraw operation will continue
+ * with the excalidraw generated name and default path.
+ * If a filepath is returned, that will be used. Include the full Vault filepath and filename
+ * with the file extension.
+ * The currentImageName is the name of the image generated by excalidraw or provided during paste.
+ * 
+ * @param data - An object containing the following properties:
+ *   @property {string} [currentImageName] - Default name for the image.
+ *   @property {string} drawingFilePath - The file path of the Excalidraw file where the image is being used.
+ * 
+ * @returns {string} - The new filepath for the image including full vault path and extension.
+ * 
+ * Example usage:
+ * ```
+ * onImageFilePathHook: (data) => {
+ *   const { currentImageName, drawingFilePath } = data;
+ *   const ext = currentImageName.split('.').pop();
+ *   // Generate a new filepath based on the drawing file name and other criteria
+ *   return `${drawingFileName} - ${currentImageName || 'image'}.${ext}`;
+ * }
+ * ```
+ *  onImageFilePathHook: (data: {
+ *   currentImageName: string; // Excalidraw generated name of the image, or the name received from the file system.
+ *   drawingFilePath: string; // The full filepath of the Excalidraw file where the image is being used.
+ * }) => string = null;  
+*/
+//ea.onImageFilePathHook = (data) => {};
+
 /**
  * If set, this callback is triggered whenever the active canvas color changes
  *   onCanvasColorChangeHook: (

src/lang/locale/zh-cn.ts

@@ -1048,8 +1048,15 @@ EXPORTDIALOG_PAGE_SIZE : "页面大小",
 EXPORTDIALOG_PAGE_ORIENTATION : "方向",
 EXPORTDIALOG_ORIENTATION_PORTRAIT : "纵向",
 EXPORTDIALOG_ORIENTATION_LANDSCAPE : "横向",
+EXPORTDIALOG_PDF_DPI : "图像质量 [DPI]",
 EXPORTDIALOG_PDF_FIT_TO_PAGE : "页面适配",
 EXPORTDIALOG_PDF_FIT_OPTION : "适配页面",
+EXPORTDIALOG_PDF_FIT_2_OPTION : "适配至 2 页" ,
+EXPORTDIALOG_PDF_FIT_4_OPTION : "适配至 4 页" ,
+EXPORTDIALOG_PDF_FIT_6_OPTION : "适配至 6 页" ,
+EXPORTDIALOG_PDF_FIT_8_OPTION : "适配至 8 页" ,
+EXPORTDIALOG_PDF_FIT_12_OPTION : "适配至 12 页" ,
+EXPORTDIALOG_PDF_FIT_16_OPTION : "适配至 16 页" ,
 EXPORTDIALOG_PDF_SCALE_OPTION : "使用图像缩放（可能跨多页）",
 EXPORTDIALOG_PDF_PAPER_COLOR : "纸张颜色",
 EXPORTDIALOG_PDF_PAPER_WHITE : "白色",
@@ -1079,4 +1086,8 @@ EXPORTDIALOG_PNGTOCLIPBOARD : "PNG 复制到剪贴板",
 EXPORTDIALOG_SVGTOCLIPBOARD : "SVG 复制到剪贴板",
 EXPORTDIALOG_PDF : "导出 PDF 文件",
 EXPORTDIALOG_PDFTOVAULT : "PDF 保存到 Vault",
+
+EXPORTDIALOG_PDF_PROGRESS_NOTICE : "正在导出页面" ,
+EXPORTDIALOG_PDF_PROGRESS_IMAGE : "的图像" ,
+EXPORTDIALOG_PDF_PROGRESS_DONE : "导出完成" ,
 };

src/shared/Dialogs/SuggesterInfo.ts

@@ -558,6 +558,21 @@ export const EXCALIDRAW_AUTOMATE_INFO: SuggesterInfo[] = [
     desc: "If set Excalidraw will call this function onDrop events.\nA return of true will stop the default onDrop processing in Excalidraw.\n\ndraggable is the Obsidian draggable object\nfiles is the array of dropped files\nexcalidrawFile is the file receiving the drop event\nview is the excalidraw view receiving the drop.\npointerPosition is the pointer position on canvas at the time of drop.",
     after: "",
   },
+  {
+    field: "onImageFilePathHook",
+    code: `onImageFilePathHook: (data: {currentImageName: string; drawingFilePath: string;}): string;`,
+    desc: "If set, this callback is triggered when an image is being saved in Excalidraw.\n"
+      + "You can use this callback to customize the naming and path of pasted images to avoid\n"
+      + 'default names like "Pasted image 123147170.png" being saved in the attachments folder,\n'
+      + "and instead use more meaningful names based on the Excalidraw file or other criteria,\n"
+      + "plus save the image in a different folder.\n\n"
+      + "If the function returns null or undefined, the normal Excalidraw operation will continue\n"
+      + "with the excalidraw generated name and default path.\n"
+      + "If a filepath is returned, that will be used. Include the full Vault filepath and filename\n"
+      + "with the file extension.\n"
+      + "The currentImageName is the name of the image generated by excalidraw or provided during paste.",
+    after: "",
+  },
   {
     field: "mostRecentMarkdownSVG",
     code: "mostRecentMarkdownSVG: SVGSVGElement;",

src/shared/ExcalidrawAutomate.ts

@@ -2742,6 +2742,40 @@ export class ExcalidrawAutomate {
     pointerPosition: { x: number; y: number }; //the pointer position on canvas
    }) => boolean = null;
 
+  /**
+   * If set, this callback is triggered when a image is being saved in Excalidraw.
+   * You can use this callback to customize the naming and path of pasted images to avoid
+   * default names like "Pasted image 123147170.png" being saved in the attachments folder,
+   * and instead use more meaningful names based on the Excalidraw file or other criteria,
+   * plus save the image in a different folder.
+   * 
+   * If the function returns null or undefined, the normal Excalidraw operation will continue
+   * with the excalidraw generated name and default path.
+   * If a filepath is returned, that will be used. Include the full Vault filepath and filename
+   * with the file extension.
+   * The currentImageName is the name of the image generated by excalidraw or provided during paste.
+   * 
+   * @param data - An object containing the following properties:
+   *   @property {string} [currentImageName] - Default name for the image.
+   *   @property {string} drawingFilePath - The file path of the Excalidraw file where the image is being used.
+   * 
+   * @returns {string} - The new filepath for the image including full vault path and extension.
+   * 
+   * Example usage:
+   * ```
+   * onImageFilePathHook: (data) => {
+   *   const { currentImageName, drawingFilePath } = data;
+   *   // Generate a new filepath based on the drawing file name and other criteria
+   *   const ext = currentImageName.split('.').pop();
+   *   return `${drawingFileName} - ${currentImageName || 'image'}.${ext}`;
+   * }
+   * ```
+   */
+   onImageFilePathHook: (data: {
+    currentImageName: string; // Excalidraw generated name of the image, or the name received from the file system.
+    drawingFilePath: string; // The full filepath of the Excalidraw file where the image is being used.
+  }) => string = null;  
+
   /**
    * if set, this callback is triggered, when an Excalidraw file is opened
    * You can use this callback in case you want to do something additional when the file is opened.

src/shared/ExcalidrawData.ts

@@ -20,7 +20,7 @@ import {
   loadSceneFonts,
 } from "../constants/constants";
 import ExcalidrawPlugin from "../core/main";
-import { TextMode } from "../view/ExcalidrawView";
+import ExcalidrawView, { TextMode } from "../view/ExcalidrawView";
 import {
   addAppendUpdateCustomData,
   compress,
@@ -52,10 +52,11 @@ import { getMermaidImageElements, getMermaidText, shouldRenderMermaid } from "..
 import { DEBUGGING, debug } from "../utils/debugHelper";
 import { Mutable } from "@zsviczian/excalidraw/types/excalidraw/utility-types";
 import { updateElementIdsInScene } from "../utils/excalidrawSceneUtils";
-import { getNewUniqueFilepath } from "../utils/fileUtils";
+import { checkAndCreateFolder, getNewUniqueFilepath, splitFolderAndFilename } from "../utils/fileUtils";
 import { t } from "../lang/helpers";
 import { displayFontMessage } from "../utils/excalidrawViewUtils";
 import { getPDFRect } from "../utils/PDFUtils";
+import { create } from "domain";
 
 type SceneDataWithFiles = SceneData & { files: BinaryFiles };
 
@@ -480,7 +481,7 @@ export class ExcalidrawData {
   selectedElementIds: {[key:string]:boolean} = {}; //https://github.com/zsviczian/obsidian-excalidraw-plugin/issues/609
 
   constructor(
-    private plugin: ExcalidrawPlugin,
+    private plugin: ExcalidrawPlugin, private view?: ExcalidrawView,
   ) {
     this.app = this.plugin.app;
     this.files = new Map<FileId, EmbeddedFile>();
@@ -1546,13 +1547,24 @@ export class ExcalidrawData {
       }
     }
 
-    const x = await getAttachmentsFolderAndFilePath(this.app, this.file.path, fname);
-    const filepath = getNewUniqueFilepath(this.app.vault,fname,x.folder);
+    let hookFilepath:string;
+    const ea = this.view?.getHookServer();
+    if(ea?.onImageFilePathHook) {
+      hookFilepath = ea.onImageFilePathHook({
+        currentImageName: fname,
+        drawingFilePath: this.view?.file?.path,
+      })
+    }
 
-    /*
-    const filepath = (
-      await getAttachmentsFolderAndFilePath(this.app, this.file.path, fname)
-    ).filepath;*/
+    let filepath:string;
+    if(hookFilepath) {
+      const {folderpath, filename} = splitFolderAndFilename(hookFilepath);
+      await checkAndCreateFolder(folderpath);
+      filepath = getNewUniqueFilepath(this.app.vault,filename,folderpath);
+    } else {
+      const x = await getAttachmentsFolderAndFilePath(this.app, this.file.path, fname);
+      filepath = getNewUniqueFilepath(this.app.vault,fname,x.folder);
+    }
 
     const arrayBuffer = await getBinaryFileFromDataURL(dataURL);
     if(!arrayBuffer) return null;

src/view/ExcalidrawView.ts

@@ -372,7 +372,7 @@ export default class ExcalidrawView extends TextFileView implements HoverParent{
   constructor(leaf: WorkspaceLeaf, plugin: ExcalidrawPlugin) {
     super(leaf);
     this._plugin = plugin;
-    this.excalidrawData = new ExcalidrawData(plugin);
+    this.excalidrawData = new ExcalidrawData(plugin, this);
     this.canvasNodeFactory = new CanvasNodeFactory(this);
     this.setHookServer();
     this.dropManager = new DropManager(this);