hm-ofd-plugin API 文档

parseOfdDocument

• 功能: 解析 OFD 文档
• 参数:
  • ofd: OFD 文件 URL 或路径 或文件流
  • success: 解析成功回调函数
  • fail: 解析失败回调函数
• 返回值: 无
• 示例:

parseOfdDocument({
  ofd: "path/to/file.ofd",
  success: (res) => console.log(res),
  fail: (err) => console.error(err),
});

displayOfdDiv

• 需在 parseOfdDocument 中使用 displayOfdCanvasDiv(res, this.ofdCtx, 300);

• 功能: 将 OFD 文档渲染到指定 DIV 元素

• 参数:

  • ofdData: parseOfdDocument 返回的解析结果
  • element: 目标 DIV 元素引用
  • width: 可选，宽度 默认 800px

• 返回值: 无

• 示例:

parseOfdDocument({
  ofd: "path/to/file.ofd",
  success: (res) => {
    displayOfdDiv(res, this.ofdDiv,width?);
  },
  fail: (err) => console.error(err),
});

html2CanvasOfd

• 需在 parseOfdDocument 中使用

• 功能: 将 OFD 文档转换为 Canvas 图像

• 参数:

  • ofd: parseOfdDocument 返回的解析结果
  • ofdElement: 目标 Canvas 元素引用
  • fileName: 输出文件名

• 返回值: Promise，解析为图像数据(Blob 或 Base64)

• 示例:

parseOfdDocument({
  ofd: "path/to/file.ofd",
  success: (res) => {
    html2CanvasOfd({
      ofd: res,
      ofdElement: this.ofdCtx,
      fileName: "xxx",
    }).then((img: any) => {
      console.log(`output->res`, img); // 返回的二进制图片流
    });
  },
  fail: (err) => console.error(err),
});

displayOfdCanvasDiv

• 同 displayOfdDiv，需在 parseOfdDocument 中使用 //解析后的 ofd 数据为 canvas 格式，方便单独调用 html2canvas 生成截图图片

• 功能: 将 OFD 文档渲染为 Canvas 元素

• 参数:

  • ofdData: parseOfdDocument 返回的解析结果
  • element: 目标 Canvas 元素引用
  • scale: 可选，缩放比例

• 返回值: 无