2.0.0 • Published 2 months ago

vhip-easybuild-api v2.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
2 months ago

vhip-easybuild-api

二次封装的用于构建 vue-plugin-hiprint 打印套件的函数库,简化你的代码

文档地址:

vhip-easybuild-api docs

v2.0.0 起支持 vue2/vue3,v1.1.1 仅支持 vue2. 对于 Vue3 项目,请使用 v2.0.0 及以上版本

Demo 地址

安装

npm install vhip-easybuild-api

导入

全局使用

全局导入会导入所有函数,在 main.js 中添加如下代码:

// 1. 全部导入:一次性导入所有函数
import { EasyVhip } from 'vhip-easybuild-api';
Vue.use(EasyVhip, { autoConnect: false }); // autoConnect 是否自动连接打印客户端,默认true

// 2. 按需导入:有选择地导入需要使用的模块 
// VhipBuilder, VhipPrinter, VhipAsst, VhipUtil
import { VhipBuilder } from 'vhip-easybuild-api';
Vue.use(VhipBuilder);

// 另外,我们提供了另一种按需导入的方式,你可以通过参数进行配置
import { EasyVhip } from 'vhip-easybuild-api';
Vue.use(EasyVhip, {
    modules: ['build','print','assist','util'], // 需要导入的模块,默认全部导入
    autoConnect: false // autoConnect 是否自动连接打印客户端,默认true
});

局部导入

局部导入可以避免全局函数名污染,在组件 <script> 中添加如下代码:

import { VhipBuilder, VhipPrinter, VhipAsst, VhipUtil } from 'vhip-easybuild-api';

// 局部导入无法一次性导入所有函数,下面的局部导入是无效的:
import { EasyVhip } from 'vhip-easybuild-api';

导入成功后就可以使用函数编写你的程序了,具体函数详情请参考文档 API 部分 ~

API

下列函数仅作检索使用,具体用法请查看文档, API 文档地址 点击访问

全局引入时,函数名具有 $ 前缀,你可以通过 this.$functionName() 的形式进行调用,例: this.$createCoreObj() .

Builder

函数名返回值备注
createElemsGroup(groupName,elements)PrintElementTypeGroup 对象实例创建元素分组
createProvider(providerName,...groups)Provider创建初始化可用的 Provider
initProviders(providers, initDefault = true)-初始化元素提供程序,initDefault 控制是否初始化默认元素
buildElemsByUlist(providerName, containerKey)-使用无序列表形式构建元素
buildElemsByHtml()-使用自定义HTML构建元素
createCoreObj(options)PrintTemplate 对象实例创建核心对象,可以通过 options 传入配置选项
design(hiprintTemplate,canvasContainer,showGrid=true)-画布设计

Printer

函数名返回值备注
browserPrint(hiprintTemplate, printData, batchNum = 1)-调用浏览器打印
clientPrint(hiprintTemplate, printData, batchNum = 1)-调用客户端打印
exportToPDF(hiprintTemplate, printData, filename, options = {})-导出为 PDF
setPaperType(hiprintTemplate,paperType)-设置纸张类型
setPaperSize(hiprintTemplate, width, height)-设置纸张尺寸
updateTemplate(hiprintTemplate, template)-更新模板
clearCanvas(hiprintTemplate)-清空画布
rotatePaper(hiprintTemplate)-旋转纸张
scaleContent(hiprintTemplate, scale, save = true)-缩放,save 控制是否在打印时保持缩放效果

Assistant

函数名返回值备注
getPrintHTML(hiprintTemplate, printData, options = {})jquery对象获取被打印的HTML
getPrintHTMLStr(hiprintTemplate, printData, options = {})string获取被打印的HTML元素字符串
getTemplateObj(hiprintTemplate)Object获取模板对象
exportTemplateJson(template, filename)-导出模板对象的json到文件

Util

函数名返回值备注
chooseImage(target)-选择图片
saveDataToFile(data, filetype, filename)-保存数据到文件
2.0.0

2 months ago

1.1.1

2 months ago

1.0.2

2 months ago

1.1.0

2 months ago

1.0.1

2 months ago

1.0.0

2 months ago

0.0.5

2 months ago

0.0.4

2 months ago

0.0.3

2 months ago

0.0.2

2 months ago

0.0.1

2 months ago