print-designer 1.0.7 → 1.0.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -27,7 +27,6 @@ npm install print-designer
27
27
 
28
28
  ```tsx
29
29
  import { BandBoundaryDesigner } from 'print-designer';
30
- import 'print-designer/dist/style.css';
31
30
 
32
31
  // 定义数据字段
33
32
  const dataFields = [
@@ -101,7 +100,7 @@ const printOptions = {
101
100
  template, // 设计模板(带区数据)
102
101
  data: previewData, // 业务数据
103
102
  dataFields, // 数据字段定义
104
- pageSettings, // 页面设置(可选)
103
+ pageSettings, // 页面设置(必填)
105
104
  };
106
105
 
107
106
  // 1. 渲染为 HTML 字符串
@@ -160,12 +159,8 @@ import { PrintPreview } from 'print-designer';
160
159
  | data | `Record<string, any>` | ✓ | - | 预览数据 |
161
160
  | dataFields | `DataField[]` | ✓ | - | 数据字段定义 |
162
161
  | onClose | `() => void` | ✓ | - | 关闭回调 |
163
- | pageWidth | `number` | | `794` | 页面宽度(px) |
164
- | pageHeight | `number` | | `1123` | 页面高度(px) |
165
- | pageMargins | `{ top, bottom, left, right }` | | `{ top: 40, bottom: 40, left: 40, right: 40 }` | 页边距(px) |
162
+ | pageSettings | `PageSettings` | | - | 页面设置(纸张尺寸、边距、方向等) |
166
163
  | showPageNumbers | `boolean` | | `true` | 是否显示页码 |
167
- | paperWidthMm | `number` | | `210` | 纸张宽度(mm),用于PDF导出 |
168
- | paperHeightMm | `number` | | `297` | 纸张高度(mm),用于PDF导出 |
169
164
 
170
165
  ### 打印输出函数
171
166
 
@@ -180,10 +175,7 @@ const result = renderToHtml({
180
175
  template: Band[], // 设计模板(带区数据)
181
176
  data: object, // 业务数据
182
177
  dataFields?: DataField[],// 数据字段定义
183
- pageSettings?: PageSettings, // 页面设置
184
- pageWidth?: number, // 页面宽度(px),默认 794
185
- pageHeight?: number, // 页面高度(px),默认 1123
186
- pageMargins?: { top, bottom, left, right }, // 页边距(px)
178
+ pageSettings: PageSettings, // 页面设置(必填)
187
179
  });
188
180
 
189
181
  // 返回结果
@@ -206,7 +198,7 @@ await exportToPdf({
206
198
  template: Band[], // 设计模板
207
199
  data: object, // 业务数据
208
200
  dataFields?: DataField[],// 数据字段定义
209
- pageSettings?: PageSettings, // 页面设置
201
+ pageSettings: PageSettings, // 页面设置(必填)
210
202
  fileName?: string, // 文件名(不含扩展名),默认 '报表_日期'
211
203
  download?: boolean, // 是否直接下载,默认 true
212
204
  scale?: number, // 图片缩放比例,默认 2
@@ -227,7 +219,7 @@ const html = getPrintableHtml({
227
219
  template: Band[],
228
220
  data: object,
229
221
  dataFields?: DataField[],
230
- pageSettings?: PageSettings,
222
+ pageSettings: PageSettings, // 页面设置(必填)
231
223
  });
232
224
 
233
225
  // 返回完整的 HTML 文档字符串(包含 DOCTYPE、打印样式等)
@@ -248,7 +240,7 @@ openPrintWindow({
248
240
  template: Band[],
249
241
  data: object,
250
242
  dataFields?: DataField[],
251
- pageSettings?: PageSettings,
243
+ pageSettings: PageSettings, // 页面设置(必填)
252
244
  });
253
245
  // 会打开新窗口并自动调用 window.print()
254
246
  ```