Excalidraw 中动态添加图像和文本到画布的实现方法

前言

Excalidraw 是一个开源的虚拟白板工具，允许用户创建手绘风格的图表和草图。在实际开发中，我们经常需要以编程方式向画布添加元素，特别是图像和文本的组合。本文将详细介绍如何正确实现这一功能。

核心问题分析

在 Excalidraw 中动态添加元素时，开发者常会遇到以下两个主要挑战：

1. 图像元素处理：需要正确处理文件引用和图像尺寸计算
2. 元素属性完整性：手动创建的元素对象可能缺少必要属性

完整解决方案

1. 初始化 Excalidraw 组件

首先需要设置 Excalidraw 组件并获取其 API 引用：

const [excalidrawAPI, setExcalidrawAPI] = useState(null);

// 在组件渲染部分
<Excalidraw excalidrawAPI={setExcalidrawAPI} />

2. 图像处理流程

处理图像需要以下几个关键步骤：

1. 获取图像数据：通过 fetch API 获取图像 blob
2. 转换为 Base64：使用 FileReader 将 blob 转换为 dataURL
3. 计算图像尺寸：创建临时 Image 对象获取原始尺寸
4. 缩放计算：根据需求调整图像显示尺寸

const response = await fetch(imageUrl);
const imageBlob = await response.blob();

const reader = new FileReader();
reader.readAsDataURL(imageBlob);

reader.onload = () => {
  const dataURL = reader.result;
  const img = new Image();
  img.src = dataURL;
  
  img.onload = () => {
    // 缩放计算
    const scaledWidth = img.width * 0.5;
    const scaledHeight = img.height * 0.5;
    // 后续处理...
  };
};

3. 添加文件到 Excalidraw

在创建图像元素前，必须先将文件添加到 Excalidraw 的文件系统中：

const fileId = `file_${Date.now()}`;
excalidrawAPI.addFiles([
  {
    id: fileId,
    dataURL,
    mimeType: imageBlob.type,
  }
]);

4. 创建图像元素

图像元素需要包含完整的属性集：

const imageElement = {
  type: "image",
  id: `image_${Date.now()}`,
  fileId,
  x: imageX,
  y: 80,
  version: 1,  // 必须包含版本号
  width: scaledWidth,
  height: scaledHeight,
  scale: [1, 1],
  isDeleted: false,
  fillStyle: "hachure",
  strokeWidth: 1,
  strokeStyle: "solid",
  roughness: 1,
  opacity: 100,
  strokeColor: "#000000",
  backgroundColor: 'transparent',
  angle: 0,
  groupIds: [],  // 必须包含空数组
};

5. 创建文本元素

对于文本元素，建议使用 convertToExcalidrawElements 方法确保属性完整：

const textElement = {
  type: "text",
  id: `text_${Date.now()}`,
  x: textX,
  y: imageY,
  width: textWidth,
  height: 100,
  text: "示例文本",
  textAlign: "center",
  strokeColor: "#54A4FC",
  fontSize: 48,
  fontFamily: "Allerta",
  verticalAlign: "top",
  baseline: 18,
};

const convertedTextElements = convertToExcalidrawElements([textElement]);

6. 更新画布场景

最后将所有元素添加到画布中：

excalidrawAPI.updateScene({
  elements: [
    ...excalidrawAPI.getSceneElementsIncludingDeleted(),
    imageElement,
    ...convertedTextElements
  ],
  appState: {
    viewBackgroundColor: '#ffffff',
    zoom: { value: 1 }
  }
});

最佳实践建议

1. 错误处理：始终添加 try-catch 块捕获可能的错误
2. 性能优化：对于大量元素，考虑批量更新而非单个添加
3. 元素定位：使用相对定位确保元素在不同画布尺寸下的适应性
4. 类型检查：使用 TypeScript 可以避免许多属性缺失的问题

常见问题解决

1. 图像不显示：检查文件是否已正确添加到文件系统，fileId 是否匹配
2. 属性缺失错误：确保所有元素包含 version 和 groupIds 等必要属性
3. 位置计算错误：使用控制台日志验证坐标计算过程

总结

通过上述方法，开发者可以可靠地在 Excalidraw 中动态添加图像和文本组合。关键在于正确处理文件引用、确保元素属性完整以及合理的场景更新策略。这种技术可以广泛应用于需要预置模板或动态生成内容的场景中。