gd-signature 使用文档
- 语雀文档: https://www.yuque.com/docs/share/7413f933-64d1-41d2-99ed-426203b7a01a?# 《gd-signature 使用文档》
一、插件依赖
动态加载,如果用户环境有这两个插件,则不加载
- jq
- pdf.js
二、使用方法
2.1、标签引入
2.2、npm
# 使用最新版本 npm i gd-signature -S # 特定版本 npm i gd-signature@x.x.x -S
页面引用
// const GDsignature = require('gd-signature')
三、功能介绍
3.1、更改插件主题色
覆盖less变量即可
- @--color-primary 主题色覆盖
- @--color-primary-border border颜色覆盖
标签方式修改主题色
new GDsignature.manual({})
3.2、半自动签署 - html
用户id: 合同id: 签章
new GDsignature.manual
start
需要配置 contract_id
与 user_id
{ const contract_id = const userId = signaturestart contract_id: contract_id user_id: userId { console } { console } }const baseUrl = 'http://192.168.2.77:9998' // 业务系统urlconst signature = baseUrl: 'http://192.168.1.206:8000/api' // paas地址 { return { axios // 根据实际需求做修改 } } { return { axios // 地址根据实际需求做修改 } }
new GDsignature.auto({})
3.3、自动签署 - html
预处理id: 签章
new GDsignature.auto
start
需要配置 prepare_id
{ preparid = signaturestart prepare_id: preparid // 预处理id { console } { console } }const baseUrl = 'http://192.168.2.77:9998' // 业务系统urlconst signature = baseUrl: 'http://192.168.1.206:8000/api' // paas地址 { return { axios // 根据实际需求做修改 } } { return { axios // 地址根据实际需求做修改 } }
new GDsignature.appManual({})
3.4、手写签章签署 + 拒签 - html
用户id: 合同id: 签章
new GDsignature.appManual
{ let contract_id = let userId = signaturestart contract_id: contract_id user_id: userId //加入此回调,证明业务需要拒签,需要自己业务实现 { // 使用此回调插件会显示拒签按钮,re里面的数据是用户ID跟合同ID,拒签实际操作逻辑还需业务系统自己去写 console; } { console } { console } }const baseUrl = 'http://192.168.2.77:9998' // 业务系统urlconst signature = baseUrl: 'http://192.168.1.206:8000/api' // paas地址 { return { axios // 根据实际需求做修改 } } { return { axios // 地址根据实际需求做修改 } }
new GDsignature.signDomain({})
3.5、签名域签章 - html
用户id: 合同id: 签章
new GDsignature.manual
start
需要配置 contract_id
与 user_id
{ const contract_id = const userId = signaturestart contract_id: contract_id user_id: userId domain: x: 300 y: 170 page: 1 name: '财务章区域1' x: 500 y: 470 page: 1 name: '财务章区域2' x: 350 y: 180 page: 4 name: '人事章区域' //需要填充的签名域坐标集合 { console } { console } }const baseUrl = 'http://192.168.2.77:9998' // 业务系统urlconst signature = baseUrl: 'http://192.168.1.206:8000/api' // paas地址 { return { axios // 根据实际需求做修改 } } { return { axios // 地址根据实际需求做修改 } }
四、属性,回调函数
4.1、baseUrl
paas api
接口
4.2、auto_close
签章成功后是否自动关闭 默认值 false
4.3、showClose
是否显示关闭按钮 默认是 true
4.4、VerifyCode
是否开启签章验证码校验 默认值 true
4.5、authSign
是否使用认证服务签章 默认值 false
4.6、authBaseUrl
认证服务器地址, authSign
为 true
时必须传
4.7、flowId
认证服务器需要的流程id, authSign
为 true
时必须传
Function(res)
4.8、success - start()中使用
- 签署成功的回调函数
Function(error)
4.9、error - start()中使用
- 签署失败的回调函数
Function(data)
4.10、refuseSign - start()中使用
- 拒签回调函数
4.11、lastPageSign
是否最后页签章, lastPageSign
为 true
限定最后页签章,默认false
4.12、domain 签名域签章时使用
业务需要签名的区域集合,数组类型,结构如下:
x:"" // x 坐标 A4当前页面绝对坐标值 必填 y:"" // y 坐标 A4当前页面绝对坐标值 必填 page:"" // 页码值 待签署页码 必填 name:"" // 签名域高亮显示时签名域名称,选填,如填写则展示该名称,数组内唯一 sealId:"" // 印章id ***** 预留字段 暂时不填充,可考虑为在用户印章列表中直接获取印章填充 w:"" // 印章宽度 ***** 预留字段 暂时不填充,考虑为当前签名域固定宽度 h:"" // 印章高度 ***** 预留字段 暂时不填充,考虑为当前签名域固定高度
使用示例
const signature = baseUrl: 'https://open.aiosign.com/api' // paas-api接口 写死这个地址就好 auto_close:true// 签章成功后是否自动关闭签章 默认falase showClose: false // 是否显示关闭按钮,默认为true VerifyCode:true // 是否开启签章验证码校验,默认为true authSign: false //使用认证服务器签章-默认为false authBaseUrl: 'http://192.168.2.199:8099/' //认证服务器地址-authSign为true时必须传 flowId: '744918968410198016' {} // 获取token {} // 获取sign signaturestart ... { console // 签章成功回调 } //加入此回调,证明业务需要拒签,需要自己业务实现 { console; } { console // 签章失败回调 }