Appearance
保存PDF
该方法的调用可以生成较为复杂的pdf文件,如果在使用过程中没有达到你的预期效果可以联系作者优化插件,作者将全力协助您使用该插件 💪
方法名
savePdf
用法
用法示例
js
//pdf数据内容
let list = [];
//标题
list.push(pdfTitle)
//报告名称
list.push(pdfSubTitle)
//个人信息
list.push(userInfo)
//换行
list.push(newLine);
//匹配结果
list.push(matchResult);
//换行
list.push(newLine);
//备注
list.push(remark);
//换行
list.push(newLine);
//签名
list.push(sign);
module.savePdf({
//接口参数
params: {
//纸张大小,可选值:A0~A10,B0~B10
pageSize: "A4",
//文件保存路径,不传或为空则插件默认保存到项目目录中
// path: "/storage/emulated/0/Download/DingTalk/诊断报告_1.pdf",
//中文字体文件,需放置到assets目录下,可以不传该参数,但是如果遇到中文不会显示
ttf: "STKAITI.TTF",
//保存内容
list: list
},
//成功返回函数
success: (res) => {
console.log(res);
},
//失败返回函数
fail: (res) => {
console.log(res)
},
//接口调用完成返回函数,不管成功还是失败都会返回
complete: (res) => {
console.log(res)
}
})js
//pdf数据内容
let list : UTSJSONObject[] = [];
//标题
list.push(pdfTitle)
//报告名称
list.push(pdfSubTitle)
//个人信息
list.push(userInfo)
//换行
list.push(newLine);
//匹配结果
list.push(matchResult);
//换行
list.push(newLine);
//备注
list.push(remark);
//换行
list.push(newLine);
//签名
list.push(sign);
module.savePdf({
//接口参数
params: {
//纸张大小,可选值:A0~A10,B0~B10
pageSize: "A4",
//文件保存路径,不传或为空则插件默认保存到项目目录中
// path: "/storage/emulated/0/Download/DingTalk/诊断报告_1.pdf",
//中文字体文件,需放置到assets目录下,可以不传该参数,但是如果遇到中文不会显示
ttf: "STKAITI.TTF",
//保存内容
list: list
},
//成功返回函数
success: (res : LevenResult) => {
console.log(res);
},
//失败返回函数
fail: (res : LevenResult) => {
console.log(res)
},
//接口调用完成返回函数,不管成功还是失败都会返回
complete: (res : LevenResult) => {
console.log(res)
}
})参数说明
| 参数名 | 参数类型 | 是否必填 | 默认值 | 参数描述 |
|---|---|---|---|---|
| params | Object | 是 | 无 | 接口请求参数 |
| params.pageSize | String | 否 | A4 | 纸张大小,可选值:A0~A10,B0~B10 |
| params.path | String | 否 | 无 | 文件保存路径,不传或为空则插件默认保存到项目目录中 |
| params.ttf | String | 否 | 无 | 中文字体文件,需放置到assets目录下,可以不传该参数,但是如果遇到中文不会显示 |
| params.list | Array[Object] | 是 | 无 | 文件内容,具体可参考示例文件 |
| params.list.type | String | 是 | 无 | 类型, image:图片,paragraph:段落,paragraphImage:图文混排,table:表格,具体请参考下方说明 |
| success | Function | 否 | 无 | 执行成功的函数 |
| fail | Function | 否 | 无 | 执行失败的函数 |
| complete | Function | 否 | 无 | 执行完成的函数,不管成功还是失败都会执行 |
image参数说明
| 参数名 | 参数类型 | 是否必填 | 默认值 | 参数描述 |
|---|---|---|---|---|
| filename | String | 是 | 无 | 文件名称或本地文件绝对路径 |
| type | String | 是 | 无 | 图片资源类型,可选值:path、drawable |
| fitWidth | String | 否 | 80 | 宽度缩放比例 |
| fitHeight | String | 否 | 80 | 高度缩放比例 |
| align | String | 否 | ALIGN_LEFT | 对齐方式:可选值:ALIGN_LEFT、ALIGN_CENTER、ALIGN_RIGHT、ALIGN_JUSTIFIED、ALIGN_TOP、ALIGN_MIDDLE、ALIGN_BOTTOM、ALIGN_BASELINE、ALIGN_JUSTIFIED_ALL |
paragraph参数说明
| 参数名 | 参数类型 | 是否必填 | 默认值 | 参数描述 |
|---|---|---|---|---|
| text | String | 是 | 无 | 显示的文本 |
| family | String | 否 | HELVETICA | 字体,可选值:COURIER、HELVETICA、TIMES_ROMAN、SYMBOL、ZAPFDINGBATS、UNDEFINED |
| size | String | 否 | 18 | 字体大小 |
| style | String | 否 | NORMAL | 样式,可选值:NORMAL、BOLD、ITALIC、UNDERLINE、STRIKETHRU、BOLDITALIC |
| color | String | 否 | BLACK | 颜色,可选值:BLACK、BLUE、CYAN、GRAY、RED、DARK_GRAY、GREEN、LIGHT_GRAY、MAGENTA、ORANGE、PINK、WHITE、YELLOW |
| align | String | 否 | ALIGN_LEFT | 对齐方式:可选值:ALIGN_LEFT、ALIGN_CENTER、ALIGN_RIGHT、ALIGN_JUSTIFIED、ALIGN_TOP、ALIGN_MIDDLE、ALIGN_BOTTOM、ALIGN_BASELINE、ALIGN_JUSTIFIED_ALL |
paragraphImage参数说明
| 参数名 | 参数类型 | 是否必填 | 默认值 | 参数描述 |
|---|---|---|---|---|
| align | String | 否 | ALIGN_LEFT | 对齐方式:可选值:ALIGN_LEFT、ALIGN_CENTER、ALIGN_RIGHT、ALIGN_JUSTIFIED、ALIGN_TOP、ALIGN_MIDDLE、ALIGN_BOTTOM、ALIGN_BASELINE、ALIGN_JUSTIFIED_ALL |
| align | String | 是 | 无 | 显示的文本 |
| list | Array[Object] | 是 | 无 | 图文列表 |
| list.type | String | 是 | 无 | 类型:image:图片,paragraph:段落 |
| list.filename | String | 是 | 无 | 文件名称或本地文件绝对路径,type=image有效 |
| list.imageType | String | 是 | 无 | 图片资源类型,可选值:path、drawable,type=image有效 |
| list.fitWidth | Integer | 否 | 80 | 宽度缩放比例,type=image有效 |
| list.fitHeight | Integer | 否 | 80 | 高度缩放比例,type=image有效 |
| list.offsetX | Float | 否 | 无 | x偏移量,type=image有效 |
| list.offsetY | Float | 否 | 无 | y偏移量,type=image有效 |
| list.text | Float | 是 | 无 | 显示的文本,type=paragraph有效 |
| list.family | String | 否 | HELVETICA | 字体,可选值:COURIER、HELVETICA、TIMES_ROMAN、SYMBOL、ZAPFDINGBATS、UNDEFINED,type=paragraph有效 |
| list.size | String | 否 | 18 | 字体大小,type=paragraph有效 |
| list.style | String | 否 | NORMAL | 样式,可选值:NORMAL、BOLD、ITALIC、UNDERLINE、STRIKETHRU、BOLDITALIC,type=paragraph有效 |
| list.color | String | 否 | BLACK | 颜色,可选值:BLACK、BLUE、CYAN、GRAY、RED、DARK_GRAY、GREEN、LIGHT_GRAY、MAGENTA、ORANGE、PINK、WHITE、YELLOW,type=paragraph有效 |
table参数说明
| 参数名 | 参数类型 | 是否必填 | 默认值 | 参数描述 |
|---|---|---|---|---|
| numColumns | Integer | 是 | 无 | 表格列数 |
| widthPercentage | Integer | 否 | 100 | 宽度比例,默认:100 |
| relativeWidths | Array[Integer] | 是 | 无 | 列宽比例,需和表格列数对应 |
| rows | Array[Object] | 是 | 无 | 表格行数据 |
| rows.columns | Array[Object] | 是 | 无 | 表格每行列数据 |
| rows.columns.text | String | 是 | 无 | 文本内容 |
| rows.columns.colSpan | Integer | 否 | 无 | 当前列所占单元格数(合并单元格) |
| rows.columns.family | String | 否 | HELVETICA | 字体,可选值:COURIER、HELVETICA、TIMES_ROMAN、SYMBOL、ZAPFDINGBATS、UNDEFINED |
| rows.columns.size | String | 否 | 18 | 字体大小 |
| rows.columns.style | String | 否 | NORMAL | 样式,可选值:NORMAL、BOLD、ITALIC、UNDERLINE、STRIKETHRU、BOLDITALIC |
| rows.columns.color | String | 否 | BLACK | 颜色,可选值:BLACK、BLUE、CYAN、GRAY、RED、DARK_GRAY、GREEN、LIGHT_GRAY、MAGENTA、ORANGE、PINK、WHITE、YELLOW |
| rows.columns.border | String | 否 | BOX | 边框,可选值:BOX,TOP,BOTTOM,LEFT,RIGHT,NO_BORDER |
| rows.columns.horizontalAlignment | String | 否 | ALIGN_LEFT | 横向对齐方式,可选值参考:align |
| rows.columns.verticalAlignment | String | 否 | ALIGN_TOP | 纵向对齐方式,可选值参考:align |
| rows.columns.paddingBottom | Integer | 否 | 0 | 下边距 |
| rows.columns.paddingTop | Integer | 否 | 0 | 上边距 |
| rows.columns.paddingLeft | Integer | 否 | 0 | 左边距 |
| rows.columns.paddingRight | Integer | 否 | 0 | 右边距 |
| rows.columns.backgroundColor | String | 否 | 无 | 背景颜色,可选值:BLACK、BLUE、CYAN、GRAY、RED、DARK_GRAY、GREEN、LIGHT_GRAY、MAGENTA、ORANGE、PINK、WHITE、YELLOW |
| rows.columns.borderColor | String | 否 | 无 | 边框颜色,可选值:BLACK、BLUE、CYAN、GRAY、RED、DARK_GRAY、GREEN、LIGHT_GRAY、MAGENTA、ORANGE、PINK、WHITE、YELLOW |
注意
图片的filename属性为图片资源名称,如果是drawable资源需放置到drawable目录下(不需要扩展名),本地资源需填写绝对路径(需要扩展名),不支持网络图片
回调
- 示例json
{ "data": { "path": "/storage/emulated/0/Android/data/uni.app.UNIBE3A797/files/1765253891460.pdf" }, "message": "", "code": 0 } - 回调说明:
参数名 参数类型 参数描述 message String 消息提示 data Object 数据对象 data.path String 生成的文件路径 code Integer 返回类型,0.成功,其他:失败
