Kaop开发接口

开发接口

Kaop

功能说明

Kaop 作为kaop服务的javascript接口对象,在安装启动Kaop服务并在页面中引入kaop.js后,即可直接在网页中使用,进行打印任务创建、获取打印机等操作,详情请参见方法列表。

方法列表

方法返回值说明
setServerUrl(serverUrl)Kaop设置服务器地址,默认http://localhost:7120
getServerUrl()String获取服务器地址
setLisence(lisence)Kaop设置授权信息
getLisence()String返回授权信息
getVersion()String获取版本信息
getName()String获取名称
getFullname()String获取全名
lookupPrinters(callback)Kaop查找打印机
createPrintJob(name,label,description)PrintJob创建打印任务

PrintJob

功能说明

PrintJob作为kaop打印任务的javascript对象类,通过Kaop.createPrintJob(name,label,description)方法创建对象实例,主要完成打印项相关的设置以及打印、预览、设计等操作,详细请参看方法列表。

方法列表

方法返回值类型说明
setItems(items)PrintJob批量设置打印项
getItems()Array获取当前设置的打印项列表
addItem(item)PrintJob添加打印项
removeItem(name)PrintJob删除指定名称打印项
getItem(name)Object获取指定名称打印项
setItemAttr(name,attrName,attrValue)PrintJob设置打印项属性
getItemAttr(name,attrName)Object获取指定名称打印项指定属性
addImage(name,x,y,width,height,url)PrintJob添加图片打印项
addText(name,x,y,width,height,text)PrintJob添加文本打印项
addRect(name,x,y,width,height)PrintJob添加矩形打印项
addOval(name,x,y,width,height)PrintJob添加椭圆形打印项
addLine(name,startX,startY,endX,endY)PrintJob添加线打印项
addArc(name,x,y,width,height,start,extent)PrintJob添加弧形打印项
addPoly(name,points)PrintJob添加多边形打印项
addQRCode(name,x,y,width,height,data)PrintJob添加二维码打印项
addBarCode(name,x,y,width,height,data)PrintJob添加条码打印项
addHtml(name,x,y,width,height,html)PrintJob添加超文本打印项
addPdf(name,url)PrintJob添加pdf打印项
addTable(name,x,y,width,height)PrintJob添加表格打印项
setTableBody(name,rows)PrintJob设置指定名称表格的表体
setTableFoot(name,rows)PrintJob设置指定名称表格的表脚
setTableHead(name,rows)PrintJob设置指定名称表格的表头
createHeaderFooter()HeaderFooter创建页眉页脚对像
createBackground()Background创建背景对象
getId()String获取打印任务id
setId(id)PrintJob设置打印任务id
getName()String获取打印任务名称
setName(name)PrintJob设置打印任务名称
getLabel()String获取打印任务标签
setLabel(label)PrintJob设置打印任务标签
getDescription()String获取打印任务描述
setDescription(description)PrintJob设置打印任务描述
getCopies()Integer获取打印任务打印份数
setCopies(copies)PrintJob设置打印任务打印份数
getOrientation()String设置打印任务打印方向
setOrientation(orientation)PrintJob设置打印任务打印方向,有效值如下:
PORTRAIT - 竖向
LANDSCAPE - 横向
getSides()String获取打印任务打印面设置
setSides(sides)PrintJob设置打印任务打印面,有效值如下:
ONE - 单面
DUPLEX - 双面长边翻转
TUMBLE - 双面短边翻转
getRange()String获取打印任务打印页范围
setRange(range)PrintJob设置打印任务打印页范围,有效值如下:
all - 所有页
自定义如:“1-5,7,9”
getQuality()String获取打印任务打印质量
setQuality(quality)PrintJob设置打印任务打印质量,有效值如下:
NORMAL - 一般
DRAFT - 低
HIGH - 高
getPrinter()String获取打印任务打印机名称
setPrinter(printer)PrintJob设置打印任务打印机名称
getFontName()String获取打印任务默认字体名称
setFontName(fontName)PrintJob设置打印任务默认字体名称
getFontSize()String获取打印任务默认字体大小
setFontSize(fontSize)PrintJob设置打印任务默认字体大小
getFontStyle()String获取打印任务默认字体风格
setFontStyle(fontStyle)PrintJob设置打印任务默认字体风格,支持如下风格:
普通 - plain
粗体 - bold
斜体 - italic
可以设置多个风格,风格之间用"\
getColor()String获取打印任务默认输出颜色
setColor(color)PrintJob设置打印任务默认输出颜色,如:“#f3f3f3"
getLanguage()String获取打印任务语言
setLanguage(language)PrintJob设置打印任务语言,如:“zh-CN”
getPrintSettings()Object获取打印任务打印设置对象
setPrintSettings(printSettings)PrintJob设置打印任务打印设置对象
loadPrintSettings(callback)PrintJob依据打印任务名称加载上次打印时使用的打印设置。
savePrintSettings(callback)PrintJob已打印任务名称作为key保存当前打印设置。
setHeader(header)PrintJob设置打印任务页眉
getHeader()HeaderFooter获取打印任务页眉
setFooter(footer)PrintJob设置打印任务页脚
getFooter()HeaderFooter获取打印任务页脚
setBackground(background)PrintJob设置打印任务背景
getBackground()Background获取打印任务背景
setBaseImage(baseImage)PrintJob设置预览参照图url
getBaseImage()String获取预览参照图url
setPrintBaseImage(printBaseImage)PrintJob设置是否打印参照图
getPrintBaseImage()Boolean获取是否打印惨照图
setPaper(paper)PrintJob设置打印任务使用纸张名称,如:“A4”、"Custom"等
getPaper()String获取打印任务使用纸张名称。
setPaperSize(width,height)PrintJob设置打印纸张大小
getPaperSize()Object获取打印纸张大小
setMargins(top,right,bottom,left)PrintJob设置打印纸张边距
getMargins()Object获取打印纸张边距
getPageSetup()Object获取打印纸张设置
setPageSetup(page)PrintJob设置打印纸张设置
setAutoSavePrintSettings(autoSavePrintSettings)PrintJob设置自动保存打印设置
getAutoSavePrintSettings()Boolean获取自动保存打印设置
preview(callback,previewMode,previewPpi,
previewBackgroundColor,previewClip)
PrintJob预览打印任务,
previewMode ,
预览模式,有效值如下:
web - 网页模式
native - 本地模式
custom - 自定义
print(callback)PrintJob打印打印任务
design(btns,callback,updateCallback,
previewMode,previewPpi)
PrintJob设计打印任务,
btns功能按钮,多个按钮之间用","分开,有效值如下:
import - 导入按钮
new - 新建按钮
export- 导出按钮
gencode - 生成代码按钮
save - 保存按钮
preview - 打印预览按钮
addPage - 添加页按钮
removePage-删除页按钮
importData(data)PrintJob导入打印任务数据
exportData()Object导出打印任务数据
upload(callback)PrintJob上传打印任务
download(callback,fields)PrintJob下载打印任务,fields打印任务的字段,多个字段之间用“,”分割,为空时获取所有字段
setCurrentPage(pageIndex)PrintJob设置当前逻辑页
getCurrentPage()Integer获取当前逻辑页编号
addPage()PrintJob添加逻辑页
removePage(pageIndex)PrintJob移除逻辑页
setPages(pages)PrintJob设置逻辑页
getPages()Array获取逻辑页
setScaleX(scaleX)PrintJob设置整体水平缩放比例
getScaleX()Float获取整体水平缩放比例
setScaleY(scaleY)PrintJob设置整体垂直缩放比例
getScaleY()Float获取整体垂直缩放比例
setOffsetX(offsetX)PrintJob设置整体水平偏移量
getOffsetX()String获取整体水平偏移量
setOffsetY(offsetY)PrintJob设置整体垂直偏移量
getOffsetY()String获取整体垂直偏移量
setContentScaleX(contentScaleX)PrintJob设置内容水平缩放比例
getContentScaleX()Float获取内容水平缩放比例
setContentScaleY(contentScaleY)PrintJob设置内容垂直缩放比例
getContentScaleY()Float获取内容垂直缩放比例
setContentOffsetX(contentOffsetX)PrintJob设置内容水平偏移量
getContentOffsetX()String获取内容水平偏移量
setContentOffsetY(contentOffsetY)PrintJob设置内容垂直偏移量
getContentOffsetY()String获取内容垂直偏移量
setAutoScale(autoScale)PrintJob设置自动缩放,有效值如下:
fitPageWidth - 自适应页宽
fitPageHeight - 自适应页高
fitOnePage - 自适应整页
getAutoScale()String获取自动缩放值
setContentHAlign(contenHAlign)PrintJob设置内容水平对齐,有效值如下:
left - 居左
right - 居右
center- 居中
getContentHAlign()String获取内容水平对齐值
setContentVAlign(contenVAlign)PrintJob设置内容垂直对齐,有效值如下:
top - 置顶
bottom- 置底
middle- 中间
getContentVAlign()String获取内容垂直对齐值

HeaderFooter

功能说明

HeaderFooter作为页眉页脚的javascript对象类,通过PrintJob 的createHeaderFooter()方法创建,使用PrintJob的setHeader(header)或setFooter(footer)进行页眉或页脚的设置,详细请参看方法列表。

方法列表

方法返回值类型说明
setItems(items)PrintJob批量设置打印项
getItems()Array获取当前设置的打印项列表
addItem(item)PrintJob添加打印项
removeItem(name)PrintJob删除指定名称打印项
getItem(name)Object获取指定名称打印项
setItemAttr(name,attrName,attrValue)PrintJob设置打印项属性
getItemAttr(name,attrName)Object获取指定名称打印项指定属性
addImage(name,x,y,width,height,url)PrintJob添加图片打印项
addText(name,x,y,width,height,text)PrintJob添加文本打印项
addRect(name,x,y,width,height)PrintJob添加矩形打印项
addOval(name,x,y,width,height)PrintJob添加椭圆形打印项
addLine(name,startX,startY,endX,endY)PrintJob添加线打印项
addArc(name,x,y,width,height,start,extent)PrintJob添加弧形打印项
addPoly(name,points)PrintJob添加多边形打印项
addQRCode(name,x,y,width,height,data)PrintJob添加二维码打印项
addBarCode(name,x,y,width,height,data)PrintJob添加条码打印项
addHtml(name,x,y,width,height,html)PrintJob添加超文本打印项
addPdf(name,url)PrintJob添加pdf打印项
addTable(name,x,y,width,height)PrintJob添加表格打印项
setTableBody(name,rows)PrintJob设置指定名称表格的表体
setTableFoot(name,rows)PrintJob设置指定名称表格的表脚
setTableHead(name,rows)PrintJob设置指定名称表格的表头
setHeight(height)HeaderFooter设置页眉或页脚的高度
getHeight()String返回页眉或页脚的高度
importData(data)HeaderFooter导入页眉或页脚数据
exportData()Object导出页眉或页脚数据

Background

功能说明

Background作为页面背景的javascript对象类,通过PrintJob 的createBackground(items)方法创建,使用PrintJob的setBackground(background)进行页面背景的设置,详细请参看方法列表。

方法列表

方法返回值类型说明
setItems(items)PrintJob批量设置打印项
getItems()Array获取当前设置的打印项列表
addItem(item)PrintJob添加打印项
removeItem(name)PrintJob删除指定名称打印项
getItem(name)Object获取指定名称打印项
setItemAttr(name,attrName,attrValue)PrintJob设置打印项属性
getItemAttr(name,attrName)Object获取指定名称打印项指定属性
addImage(name,x,y,width,height,url)PrintJob添加图片打印项
addText(name,x,y,width,height,text)PrintJob添加文本打印项
addRect(name,x,y,width,height)PrintJob添加矩形打印项
addOval(name,x,y,width,height)PrintJob添加椭圆形打印项
addLine(name,startX,startY,endX,endY)PrintJob添加线打印项
addArc(name,x,y,width,height,start,extent)PrintJob添加弧形打印项
addPoly(name,points)PrintJob添加多边形打印项
addQRCode(name,x,y,width,height,data)PrintJob添加二维码打印项
addBarCode(name,x,y,width,height,data)PrintJob添加条码打印项
addHtml(name,x,y,width,height,html)PrintJob添加超文本打印项
addPdf(name,url)PrintJob添加pdf打印项
addTable(name,x,y,width,height)PrintJob添加表格打印项
setTableBody(name,rows)PrintJob设置指定名称表格的表体
setTableFoot(name,rows)PrintJob设置指定名称表格的表脚
setTableHead(name,rows)PrintJob设置指定名称表格的表头
importData(data)Background导入背景数据
exportData()Object导出背景数据
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值