Skip to content

保存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)
  }
})

参数说明

参数名参数类型是否必填默认值参数描述
paramsObject接口请求参数
params.pageSizeStringA4纸张大小,可选值:A0~A10,B0~B10
params.pathString文件保存路径,不传或为空则插件默认保存到项目目录中
params.ttfString中文字体文件,需放置到assets目录下,可以不传该参数,但是如果遇到中文不会显示
params.listArray[Object]文件内容,具体可参考示例文件
params.list.typeString类型, image:图片,paragraph:段落,paragraphImage:图文混排,table:表格,具体请参考下方说明
successFunction执行成功的函数
failFunction执行失败的函数
completeFunction执行完成的函数,不管成功还是失败都会执行

image参数说明

参数名参数类型是否必填默认值参数描述
filenameString文件名称或本地文件绝对路径
typeString图片资源类型,可选值:path、drawable
fitWidthString80宽度缩放比例
fitHeightString80高度缩放比例
alignStringALIGN_LEFT对齐方式:可选值:ALIGN_LEFT、ALIGN_CENTER、ALIGN_RIGHT、ALIGN_JUSTIFIED、ALIGN_TOP、ALIGN_MIDDLE、ALIGN_BOTTOM、ALIGN_BASELINE、ALIGN_JUSTIFIED_ALL

paragraph参数说明

参数名参数类型是否必填默认值参数描述
textString显示的文本
familyStringHELVETICA字体,可选值:COURIER、HELVETICA、TIMES_ROMAN、SYMBOL、ZAPFDINGBATS、UNDEFINED
sizeString18字体大小
styleStringNORMAL样式,可选值:NORMAL、BOLD、ITALIC、UNDERLINE、STRIKETHRU、BOLDITALIC
colorStringBLACK颜色,可选值:BLACK、BLUE、CYAN、GRAY、RED、DARK_GRAY、GREEN、LIGHT_GRAY、MAGENTA、ORANGE、PINK、WHITE、YELLOW
alignStringALIGN_LEFT对齐方式:可选值:ALIGN_LEFT、ALIGN_CENTER、ALIGN_RIGHT、ALIGN_JUSTIFIED、ALIGN_TOP、ALIGN_MIDDLE、ALIGN_BOTTOM、ALIGN_BASELINE、ALIGN_JUSTIFIED_ALL

paragraphImage参数说明

参数名参数类型是否必填默认值参数描述
alignStringALIGN_LEFT对齐方式:可选值:ALIGN_LEFT、ALIGN_CENTER、ALIGN_RIGHT、ALIGN_JUSTIFIED、ALIGN_TOP、ALIGN_MIDDLE、ALIGN_BOTTOM、ALIGN_BASELINE、ALIGN_JUSTIFIED_ALL
alignString显示的文本
listArray[Object]图文列表
list.typeString类型:image:图片,paragraph:段落
list.filenameString文件名称或本地文件绝对路径,type=image有效
list.imageTypeString图片资源类型,可选值:path、drawable,type=image有效
list.fitWidthInteger80宽度缩放比例,type=image有效
list.fitHeightInteger80高度缩放比例,type=image有效
list.offsetXFloatx偏移量,type=image有效
list.offsetYFloaty偏移量,type=image有效
list.textFloat显示的文本,type=paragraph有效
list.familyStringHELVETICA字体,可选值:COURIER、HELVETICA、TIMES_ROMAN、SYMBOL、ZAPFDINGBATS、UNDEFINED,type=paragraph有效
list.sizeString18字体大小,type=paragraph有效
list.styleStringNORMAL样式,可选值:NORMAL、BOLD、ITALIC、UNDERLINE、STRIKETHRU、BOLDITALIC,type=paragraph有效
list.colorStringBLACK颜色,可选值:BLACK、BLUE、CYAN、GRAY、RED、DARK_GRAY、GREEN、LIGHT_GRAY、MAGENTA、ORANGE、PINK、WHITE、YELLOW,type=paragraph有效

table参数说明

参数名参数类型是否必填默认值参数描述
numColumnsInteger表格列数
widthPercentageInteger100宽度比例,默认:100
relativeWidthsArray[Integer]列宽比例,需和表格列数对应
rowsArray[Object]表格行数据
rows.columnsArray[Object]表格每行列数据
rows.columns.textString文本内容
rows.columns.colSpanInteger当前列所占单元格数(合并单元格)
rows.columns.familyStringHELVETICA字体,可选值:COURIER、HELVETICA、TIMES_ROMAN、SYMBOL、ZAPFDINGBATS、UNDEFINED
rows.columns.sizeString18字体大小
rows.columns.styleStringNORMAL样式,可选值:NORMAL、BOLD、ITALIC、UNDERLINE、STRIKETHRU、BOLDITALIC
rows.columns.colorStringBLACK颜色,可选值:BLACK、BLUE、CYAN、GRAY、RED、DARK_GRAY、GREEN、LIGHT_GRAY、MAGENTA、ORANGE、PINK、WHITE、YELLOW
rows.columns.borderStringBOX边框,可选值:BOX,TOP,BOTTOM,LEFT,RIGHT,NO_BORDER
rows.columns.horizontalAlignmentStringALIGN_LEFT横向对齐方式,可选值参考:align
rows.columns.verticalAlignmentStringALIGN_TOP纵向对齐方式,可选值参考:align
rows.columns.paddingBottomInteger0下边距
rows.columns.paddingTopInteger0上边距
rows.columns.paddingLeftInteger0左边距
rows.columns.paddingRightInteger0右边距
rows.columns.backgroundColorString背景颜色,可选值:BLACK、BLUE、CYAN、GRAY、RED、DARK_GRAY、GREEN、LIGHT_GRAY、MAGENTA、ORANGE、PINK、WHITE、YELLOW
rows.columns.borderColorString边框颜色,可选值: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
    }
  • 回调说明:
    参数名参数类型参数描述
    messageString消息提示
    dataObject数据对象
    data.pathString生成的文件路径
    codeInteger返回类型,0.成功,其他:失败