开发接口
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 | 导出背景数据 |