Api⚓︎
简介
vhip-easybuild-api 是对打印套件 vue-plugin-hiprint 构建过程进行二次封装的函数库，你可以使用该包来简化代码，避免项目代码的冗长。
简介⚓︎
封装的函数按功能性质划分到四个模块中，分别为：构建（Builder）打印（Printer）开发辅助（Assistant）以及一些工具（Util）。关于它们你可以通过下表来了解：
| 功能性质 | 模块 | 全局导入标识 | 说明 |
|---|---|---|---|
| 构建 | VhipBuilder | build | 包含用来构建打印套件的api，是使用打印套件的核心函数 |
| 打印 | VhipPrinter | 包含调用打印以及打印相关的api，通过这些函数完成打印、导出PDF、纸张选择等功能 | |
| 辅助 | VhipAsst | assist | 包含一些辅助程序开发的api，如获取模板json，获取HTML等，你可以在程序开发时使用到它们 |
| 工具 | VhipUtil | util | 包含一些工具api，如选择图片、导出数据到文件等 |
| 关于 api 具体的使用和介绍，请浏览相应的Section. |
Warning
导入后就可以使用这些函数了，需要注意的是：
- 对于 Build 函数通常需要在 mounted 中使用
- 对于 全局 引入方式，其引用方式为
this.$functionName(), 即需要添加 $ 前缀 - 对于 局部 引入方式，其引用方式为
ModuleName.functionName(), 即通过模块名调用
Build⚓︎
| 函数 | 参数 | 返回值 | 备注 |
|---|---|---|---|
| buildElemsByHtml() | - | - | 使用自定义HTML构建元素 |
| buildElemsByUlist(providerName, containerKey) | providerName: 提供程序的名称；containerKey: 用来构建元素的容器标识，可以是 id 或 class，应带有符号 | - | 使用无序列表形式构建元素 |
| createCoreObj(options) | options: 配置选项 | HiprintTemplate | 创建核心对象，可以通过 options 传入配置选项 |
| createElemsGroup(groupName, elements) |
groupName: 分组名称；elements: 分组下的元素数组 | PrintElementTypeGroup | 创建元素分组 |
| createProvider(providerName, ...groups) |
providerName: 提供程序的名称；groups: 可变长参数，创建的元素分组对象 | Provider | 创建初始化可用的 Provider |
| design(hpt, containerKey, showGrid) |
hpt: 打印核心对象；containerKey: 用来构建画布的容器标识，可以是 id 或 class，应带有符号；showGrid: 是否显示网格，默认值 true | - | 画布设计 |
| initProviders(providers, initDefault) | providers: 提供程序，多个时使用数组；initDefault: 是否初始化默认元素，默认值 true | - | 初始化元素提供程序，initDefault 控制是否初始化默认元素 |