vg-print 1.0.2 → 1.0.5

package/README.md

@@ -272,4 +272,135 @@ const opened = hiprint.hiwebSocket.opened
 - 预览组件：`src/vue3/Preview.vue:1-63`
 - 设计器组件：`src/vue3/Designer.vue:1-42`
 - 头部组件：`src/vue3/Header.vue:1-38`
-- 拖拽组件：`src/vue3/DragBox.vue:1-28`
+- 拖拽组件：`src/vue3/DragBox.vue:1-28`
+
+## 方法使用案例集合
+
+### 注册与 Provider 插件
+
+```
+import { register } from 'vg-print'
+import pluginEleBwip from '@vg-print/plugin-ele-bwip-js'
+
+register({
+  authKey: '',
+  plugins: [
+    pluginEleBwip({ /* 插件参数 */ })
+  ]
+})
+```
+
+### 全局配置 setConfig
+
+```
+import { setConfig } from 'vg-print'
+
+setConfig({
+  showAdsorbLine: true,
+  showPosition: true,
+  showSizeBox: true
+})
+```
+
+### 设计器渲染与获取模板
+
+```
+import { createPrintTemplate } from 'vg-print'
+
+const t = createPrintTemplate({ template: templateJson })
+t.design('#SVPrint', { grid: true })
+const html = t.getHtml(printData) // 参考 src/views/preview.vue:95-101
+const json = t.getJson()          // 参考 src/views/index.vue:882
+```
+
+### 设置与导出模板 JSON
+
+```
+t.setJson(newJson)
+const exported = t.getJson()
+```
+
+### 浏览器打印
+
+```
+t.print(printData, { /* options */ })
+```
+
+### 直接打印（需客户端）
+
+```
+t.print2(printData, {
+  title: '打印标题',
+  printer: 'HP LaserJet'
+})
+// 判断连接与读取打印机列表
+hiprint.hiwebSocket.opened           // 参考 src/views/preview.vue:59-66
+const printers = hiprint.hiwebSocket.getPrinterList() // 参考 src/hiprint/hiprint.bundle.js:7779
+```
+
+### 导出 PDF（两类模式）
+
+1) 普通模板，导出预览全部页：
+
+```
+t.toPdf(printData, '打印预览pdf')
+```
+
+2) 小模板 A4 排版（把小模板排到 A4）参考 `src/views/index.vue:704-744`：
+
+```
+t.toPdf(printData, '打印预览pdf', {
+  paperWidth: 210,
+  paperHeight: 297,
+  onProgress: (cur, total) => console.log('toPdf 进度', Math.floor((cur/total)*100))
+})
+```
+
+### 导出图片（多页合成、清晰度、排版）
+
+```
+// 多张图片，每张合成 6 页，自动下载 JPEG（参考 src/views/index.vue:704-744）
+await t.toImage(printData, {
+  limit: 6,
+  isDownload: true,
+  name: 'A4排版',
+  type: 'image/jpeg',
+  pixelRatio: 2,
+  quality: 0.8,
+  paperWidth: 210,
+  paperHeight: 297,
+  toType: 'url'
+})
+```
+
+### 客户端高级 API（选用）
+
+```
+// 刷新打印机列表
+hiprint.hiwebSocket.refreshPrinterList() // 参考 src/hiprint/hiprint.bundle.js:7782
+
+// 获取客户端列表与信息
+hiprint.hiwebSocket.getClients()         // 参考 src/hiprint/hiprint.bundle.js:7789
+hiprint.hiwebSocket.getClientInfo()      // 参考 src/hiprint/hiprint.bundle.js:12551-12554
+
+// IPP 打印与请求
+hiprint.hiwebSocket.ippPrint({ /* options */ })   // 参考 src/hiprint/hiprint.bundle.js:7803
+hiprint.hiwebSocket.ippRequest({ /* options */ }) // 参考 src/hiprint/hiprint.bundle.js:7810
+```
+
+### Vue 插件全局快捷：$print / $print2
+
+```
+// main.js
+import { createApp } from 'vue'
+import App from './App.vue'
+import { hiPrintPlugin } from 'vg-print'
+
+const app = createApp(App)
+app.use(hiPrintPlugin) // 全局挂载 this.$print / this.$print2 参考 src/index.js:34-75
+app.mount('#app')
+
+// 组件中使用
+this.$print(undefined, templateJson, printData, options)
+this.$print2(undefined, templateJson, printData, options)
+```