插件介绍
约 745 字大约 2 分钟
...
2026-09-28
插件介绍
sv-print插件是结合底层逻辑。使用hook实现的插件机制。在特定的时机执行,实现插件功能。
例如: 新增文本,图片元素的新样式参数, 新增echarts图表元素,bwip-js元素, 自定义全局快捷键等。
插件列表
按插件类型分组,每个插件的说明、示例代码与高级用法见对应文档:
| 类型 | 插件 |
|---|---|
| api 插件 | api-pdf / api-pdf3 / api-pdf-vector / api-image / api-excel / api-word |
| 元素插件 | box / bwip-js / shtml / stable / w2html / pdf / e2table / echarts / fabric / seal |
| 功能插件 | formatter / i18n / options-modify / scale / text-auto / driver |
| view插件 | view-code-edit / view-data-source / view-ele-tools / view-ai |
hook 列表
温馨提示
部分 hook 回调的参数不太好 翻译 它的具体作用。请 log 查看。
每个插件,可使用多个hook。
| hook | 说明 | 回调参数 | 备注 |
|---|---|---|---|
| init | hiprint.register 时的 hook | ConfigOptionItemsElementTypeshinnnhiprint | 可实现自定义参数 |
| ready | $(document).ready 时的 hook | pwindow | ready 时处理 |
| documentShortcutKeys | 全局快捷键 hook | panelevent | 自定义全局快捷键 如: Ctrl + 1 |
| shortcutKeys | 面板快捷键 hook当设计面板获取到焦点时的快捷键 | panelevent | 如:Ctrl + B 将选中元素 字体加粗 |
| createPrintElement | 创建元素 hook | ConfigBasePrintElementOptionsSuppereleeleOpt | 配合init、beforePrint等 hook 自定义新的元素 |
| newPrintTemplate | 创建模板对象 hook | templateoptions | |
| newPanel | 创建面板对象 hook | paneloptions | |
| onDesigned | 设计器创建完成 hook | hiprintdesignerUtils | |
| onPreview | 显示预览时 hook | rootdesignerUtilsoptions | root DOM |
| getOptionItem | 渲染元素参数前 hook处理元素 参数渲染 | item | 返回该item |
| beforeGetHtml | 获取html前 hook处理新元素 打印样式 | templateinfoopts | 返回该 3 个参数 |
| beforePrint | 浏览器打印前 hook处理新元素 打印样式 | templateinfoopts | 返回该 3 个参数 |
| beforePrint2 | 直接打印前 hook处理新元素 打印样式 | templateinfo | 返回该 2 个参数 |
版权所有
版权归属:sv-print
