print-designer 1.0.9 → 1.0.12

package/README.md

@@ -90,17 +90,14 @@ import {
     openPrintWindow 
 } from 'print-designer';
 
-// 从存储加载设计模板
+// 从存储加载设计数据
 const savedDesign = JSON.parse(localStorage.getItem('design') || '{}');
-const template = savedDesign.bands;
-const pageSettings = savedDesign.pageSettings;
 
-// 打印配置
+// 打印配置（统一的 JSON 结构）
 const printOptions = {
-    template,           // 设计模板（带区数据）
-    data: previewData,  // 业务数据
-    dataFields,         // 数据字段定义
-    pageSettings,       // 页面设置（可选）
+    design: savedDesign,   // 设计数据（包含 bands, pageSettings）
+    data: previewData,     // 业务数据
+    dataFields,            // 数据字段定义（必填）
 };
 
 // 1. 渲染为 HTML 字符串
@@ -159,12 +156,8 @@ import { PrintPreview } from 'print-designer';
 | data | `Record<string, any>` | ✓ | - | 预览数据 |
 | dataFields | `DataField[]` | ✓ | - | 数据字段定义 |
 | onClose | `() => void` | ✓ | - | 关闭回调 |
-| pageWidth | `number` | | `794` | 页面宽度(px) |
-| pageHeight | `number` | | `1123` | 页面高度(px) |
-| pageMargins | `{ top, bottom, left, right }` | | `{ top: 40, bottom: 40, left: 40, right: 40 }` | 页边距(px) |
+| pageSettings | `PageSettings` | ✓ | - | 页面设置（纸张尺寸、边距、方向等） |
 | showPageNumbers | `boolean` | | `true` | 是否显示页码 |
-| paperWidthMm | `number` | | `210` | 纸张宽度(mm)，用于PDF导出 |
-| paperHeightMm | `number` | | `297` | 纸张高度(mm)，用于PDF导出 |
 
 ### 打印输出函数
 
@@ -176,13 +169,9 @@ import { PrintPreview } from 'print-designer';
 import { renderToHtml } from 'print-designer';
 
 const result = renderToHtml({
-    template: Band[],        // 设计模板（带区数据）
+    design: DesignData,      // 设计数据（bands, pageSettings）
     data: object,            // 业务数据
-    dataFields?: DataField[],// 数据字段定义
-    pageSettings?: PageSettings, // 页面设置
-    pageWidth?: number,      // 页面宽度(px)，默认 794
-    pageHeight?: number,     // 页面高度(px)，默认 1123
-    pageMargins?: { top, bottom, left, right }, // 页边距(px)
+    dataFields: DataField[], // 数据字段定义（必填）
 });
 
 // 返回结果
@@ -202,10 +191,9 @@ console.log(result.paperHeightMm);// 纸张高度(mm)
 import { exportToPdf } from 'print-designer';
 
 await exportToPdf({
-    template: Band[],        // 设计模板
+    design: DesignData,      // 设计数据
     data: object,            // 业务数据
-    dataFields?: DataField[],// 数据字段定义
-    pageSettings?: PageSettings, // 页面设置
+    dataFields: DataField[], // 数据字段定义（必填）
     fileName?: string,       // 文件名（不含扩展名），默认 '报表_日期'
     download?: boolean,      // 是否直接下载，默认 true
     scale?: number,          // 图片缩放比例，默认 2
@@ -223,10 +211,9 @@ const pdfBlob = await exportToPdf({ ...options, download: false });
 import { getPrintableHtml } from 'print-designer';
 
 const html = getPrintableHtml({
-    template: Band[],
-    data: object,
-    dataFields?: DataField[],
-    pageSettings?: PageSettings,
+    design: DesignData,      // 设计数据
+    data: object,            // 业务数据
+    dataFields: DataField[], // 数据字段定义（必填）
 });
 
 // 返回完整的 HTML 文档字符串（包含 DOCTYPE、打印样式等）
@@ -244,16 +231,26 @@ const html = getPrintableHtml({
 import { openPrintWindow } from 'print-designer';
 
 openPrintWindow({
-    template: Band[],
-    data: object,
-    dataFields?: DataField[],
-    pageSettings?: PageSettings,
+    design: DesignData,      // 设计数据
+    data: object,            // 业务数据
+    dataFields: DataField[], // 数据字段定义（必填）
 });
 // 会打开新窗口并自动调用 window.print()
 ```
 
 ## 类型定义
 
+### DesignData
+
+设计数据（统一的 JSON 结构）。
+
+```typescript
+interface DesignData {
+    bands?: Band[];                    // 带区设计数据（可选，为空时使用默认带区）
+    pageSettings?: PageSettings;       // 页面设置（可选，为空时使用默认 A4 设置）
+}
+```
+
 ### DataField
 
 数据字段定义。