JSAPI单接口示例

序号	英文名	中文名
registListener	注册监听	执行修改参数需要被设置回调的参数名回调函数名是否监听事后事件
unRegistListener	取消监听	执行修改参数 listenerId 需要被设置回调的参数名
setReaderVisible	显示/隐藏阅读器	执行修改参数是否显示恢复上次关闭前阅读器所在的位置
openFile	打开文件	执行修改参数文件路径
closeFile	关闭文件	执行
openFile2	打开文件2	执行修改参数文件路径是否只读
openFileSyn	同步阻塞打开文件	执行修改参数文件路径是否只读
openurl	打开远程版式文件	执行修改参数文件路径保存位置是否只读
openContinuousFile	打开接续文档	执行修改参数接续文档信息
openFile3	打开文件3	执行修改参数文件路径指定打开文件的权限
openFile4	打开文件4	执行修改参数文件路径参数
openSvcFile	打开内容服务上的文档	执行修改参数内容服务地址文档标识
openSvcFile2	打开内容服务上的文档2	执行修改参数文档标识
saveFile	保存文档	执行修改参数保存路径是否嵌入字体
saveFileWithResult	保存文件返回信息	执行修改参数文件路径
openOfficeFile	打开流式（Office）文件	执行修改参数被打开文件位置文件名称后缀
openBase64File	打开文件流	执行修改参数文件流
saveBase64File	保存文件流	执行
InsertBase64File	插入base64流	执行修改参数 base64数据流文件 {"baseinfo":"","pagenumber":"1","pagedirect":"before"}
saveBase64FilebyIndex	获取文件base64信息	执行修改参数页面范围
saveOFDBase64ByImageBase64	将图片base64生成ofdbase64	执行修改参数图片base64流
saveEnvFile	保存安全信封	执行修改参数安全OFD信息 {"filename":"D:/tmp/123.ofd","savefilename":"D:/tmp/test.sfd","enddate":"2021-08-01","autodestruction":"false","authority":"copy","encrypttype":"password","password":"123456"}
openEnvFile	打开安全信封	执行修改参数文件路径安全ofd密码或证书路径
checkUKey	检测加密设备是否存在	执行
getEnvelopePrintCopies	获取加密信封打印份数	执行
InsertCirculationControlInfo	流转管控接口	执行修改参数管控信息 {"username":"111,222,333"}
printFile	打印文档	执行修改参数打印份数份数名称
printFile3	设置灰度文档打印	执行修改参数发送到打印机的打印任务名称是否灰度打印
exitAfterPrint	打印完成后退出	执行
showPrintSetting	显示打印设置界面	执行
printFileBySetting	按指定的设置直接打印	执行修改参数打印参数属性
printFileCopies	按指定份数打印文档	执行修改参数打印份数
setPrintCopies	设置最大打印份数	执行修改参数最大打印文件份数
setPrinterName	设置打印机名	执行修改参数打印机名
setPrintResolution	设置打印分辨率	执行修改参数打印分辨率
setPrintCopyNo	设置打印份号	执行修改参数打印份号
setPrintCompsiteChecked	设置打印对话框组件是否勾选	执行修改参数组件名称是否选中
setPrintCompsiteEnable	设置打印对话框选项是否可用	执行修改参数组件名称是否可用
setScanConfigInfo	配置纸质文件数字化时的扫描配置	执行修改参数配置信息
setCompsiteVisible	显示/隐藏组件	执行修改参数界面元素的标识是否可见
getCompsiteVisible	获取指定界面元素的可见性	执行修改参数界面元素的标识
setCompsiteEnable	启用/禁用组件	执行修改参数界面元素的标识是否可用
getCompsiteEnable	获取界面元素可用性	执行修改参数界面元素的标识
getAllCompsiteNames	获取所有可控组件	执行
setViewPreference	设置视图首选项	执行修改参数视图首选项值名称首选项取值
setZoomRadio	设置页面显示比例	执行修改参数显示比例
getZoomRadio	获取页面显示比例	执行
scrollScreenOneTime	设置滚动条属性	执行修改参数是否向后滚动
setUserName	设置用户名	执行修改参数用户名
getUserName	获取用户名	执行
setMetaData	设置文档元数据	执行修改参数元数据标识元数据值
getMetaData	获取文档元数据	执行修改参数元数据标识
addTrackInfo	添加追踪条码或信息	执行修改参数配置字符串
clearTrackInfo	清除追踪水印	执行
searchText	查找文本	执行修改参数待查找的内容是否进行大小写匹配是否进行全字符匹配是否向上查找
setFindTextColor	设置查找功能文本选择颜色	执行修改参数文本选择颜色
addDynamicLink	设置高亮文字	执行修改参数使用者信息链接地址显示颜色是否定位到第一个结果
clearDynamicLink	清除所有高亮关键词	执行
addFreeText	添加文本批注（文本框注释）	执行修改参数文本框批注 {"text":"1231231231","page-index":"1","pos-x":"10","pos-y":"10", "font-family": "simsun","font-size":"36","font-style":"italic","font-weight": "bold", "font-color": "#ff0000"}
getTaggedText	获取指定标签（语义）内容	执行修改参数标签的标识
getTaggedPosition	获取标签（语义）位置	执行修改参数标签的标识
getDocumentText	获取全文文本内容	执行
DistillOFD	拆分OFD文件	执行修改参数指定拆分格式
MergeOFD	合并OFD文件	执行修改参数指定合并的文件列表
getAllFreeTextBy	获取文本批注ID	执行修改参数用户环节
getFreeTextInfoById	根据ID获取文本批注内容	执行修改参数批注ID
getAllFreeTextNameBy	获取文本批注标识	执行修改参数用户环节
getFreeTextInfoByName	获取文本批注的信息	执行修改参数文本批注标识名
modifyFreeTextByName	修改指定名称文本批注信息	执行修改参数文本批注标识名要修改的信息 {"text":"new_text_content","font-family": "SimSun","font-size": "20","font-style": "normal","font-weight": "bold","font-color": "#ff0000","name": "new_name","dropdownoptions": "item1,itme2,item3"}
modifyFreeTextById	修改指定ID文本批注内容	执行修改参数文本批注标识名要修改的信息 {"font-family":"simsun","font-size":"10","font-style":"10","font-size":"italic","font-weight":"bold","font-underline":"underline","font-color":"#000000"}
getFreeTextContentById	获取文本批注内容	执行修改参数文本批注ID
deleteAllFreeTextBy	删除指定文本批注	执行修改参数用户环节
performClick	模拟点击	执行修改参数组件名称
performClickConfigable	模拟界面点击操作	执行修改参数功能入口按钮或者功能的名称动作功能参数json信息
setSealId	设置印章标识	执行修改参数印章标识
setSealName	设置印章名称	执行修改参数印章名称
sealSignBySetting	自定义盖章	执行修改参数章信息json字符
getSignatureVerifyInfo	获取验章结果	执行修改参数印章ID
setSealSignExtendParam	设置签章额外参数	执行修改参数需要额外参数的操作所需的额外参数
showSignature	显示文档中的签章	执行修改参数签名ID
getSignaturesCount	获取签章个数	执行修改参数签名的类型
getSignatureID	获取签章ID	执行修改参数章的索引号
getSignatureSeal	获取签章、印章数据	执行修改参数印章ID
getSignatureInfo	获取签章信息	执行修改参数指定印章ID
LockSeal	签章锁定	执行修改参数签章密码
applyPreSeal	预盖章应用签章	执行修改参数指定印章id
sealByBatch	批量打开文件盖章	执行修改参数带签章的源文件待盖章文件路径保存文件路径盖章页码
getSignatureSignedValue	获取签名数据	执行修改参数印章ID
deleteSignature	删除签名	执行修改参数签名ID
validSignature	验证所有签名（弹对话框）	执行修改参数是否在线验证签名标识
validSignatureWithResult	验证所有签名	执行修改参数印章ID 是否在线验证签名标识
setSealSignMethod	设置签章所使用的签名方法	执行修改参数签名方法标识
setPrintSealEnable	设置是否允许打印签章	执行修改参数章的索引号
AddChapterBy	添加文号章	执行修改参数章信息 {"chapterid":"1", "page-index":"1", "pos-x":"10", "pos-y":"10", "values":"1,1,1,2,1","applysign":"false"}
AddChapterByIDAndUrl	添加自定义文号章	执行修改参数章信息 {"type":"templateid","templateinfo":"1","templatename":"suwelldy1","page-index":"1","pos-x":"10","pos-y":"90","values":"20,1,2,5,0","applysign":"false","forceupdate":"false"}
GetChapterParamInfo	获取字段信息	执行修改参数指定章模板信息 {"chapterid":"1"}
AddChapterFileByParamInfo	根据chapterInfo动态刷新生成ofd文件	执行修改参数指定章模板信息 {"saveofdpath":"D:/tmp/addChapterFileByParamInfo.ofd", "values":"20,1,2,5,0"}
GoToActionByChapterCustomtag	文号章字段语义结点跳转	执行修改参数指定章模板信息 {"customtagname":"公告"}
AddCustomtagObjectDataInfo	添加语义结点	执行修改参数语义结点信息名称 {"customtagname":"公告", "key":"test", "value":"通知"}
decryptAlltoBlack	文档内容脱密为黑色	执行修改参数另存文件名
decryptAlltoGray	文档内容脱密为灰色	执行修改参数另存文件名
decryptAllSeals	印章脱密	执行修改参数红色文字是否脱密成黑字图片是否脱密成黑色印章是否脱密成黑色保存路径
decryptAllSealsEx	印章脱密	执行修改参数脱密信息
setSealUserInfo	设置印章用户信息	执行修改参数印章用户信息
setSealTransInfo	设置远程签章信息	执行修改参数远程签章相关信息
setSealList	设置签章列表信息	执行修改参数签章列表信息
SetSignatureIndex	设置签章编号	执行修改参数远程签章相关信息
mergeSignatures	合并签章	执行修改参数待合并文档列表
exit	退出阅读器	执行
ExportFileAnnot	导出注释	执行修改参数导出注释内容 {"destofdfilepath":"D:/tmp/export.ofd","srcofdfilepath":"D:/tmp/savefile.ofd","annotationtype":"STAMP","subtype":"FreeText","user":"1","datatag":"1"}
ImportFileAnnot	导入注释	执行修改参数导入注释内容 {"destofdfilepath":"D:/tmp/123.ofd","srcofdfilepath":"D:/tmp/export.ofd","annotationtype":"STAMP","subtype":"FreeText","user":"1","datatag":"1"}
setReadOnlyByAnnotId	设置注释属性	执行修改参数注释的id 是否只读
setBackGroundInfo	设置背景	执行修改参数配置的xml字符串 <fillcolor><color>#FFFFFF</color></fillcolor>
setForeGroundInfo	设置前景	执行修改参数配置的xml字符串 <fillcolor><color>#FFFFFF</color></fillcolor>
setScale	设置视图缩放率	执行修改参数显示比例
setSingleMode	设置文档显示模式	执行修改参数是否单文件模式
isSingleMode	获取当前是否单文档模式	执行
setMaskMode	设置掩膜注释生效模式	执行修改参数掩膜注释生效模式
setNavigationButtonVisible	设置导航栏面板按钮	执行修改参数导览面板类型按钮名称按钮是否显示
setNavigatorVisible	导航栏子项属性	执行修改参数导航栏子项名称隐藏/显示
setUserID	设置用户id	执行修改参数用户id
getUserID	获取用户ID	执行
setDataTag	设置数据标签	执行修改参数数据标签
setUserToken	设置用户单次登录标识	执行修改参数用户单次登录标识
getDuplicteInfo	获取加密信封用户信息	执行修改参数获取用户信息的关键字
setAdminUserID	设置管理员用户的UserID	执行修改参数指定用户ID
setDocInfo	设置文档信息	执行修改参数配置字符串 <setinfo type="docinfo"><parameter name="secretlevel" value="机密"/><parameter name="secretdate" value="2021-6-1"/><parameter name="encryptid" value="2"/><parameter name="database" value="文档库"/><parameter name="doctype" value="文种"/><parameter name="docid" value="文号"/></setinfo >
getDocInfo	获取文档信息	执行
setMBInfo	设置密级标志信息	执行修改参数密级标志信息
addWaterMakerAnnot	插入文字水印	执行修改参数水印相关信息 <WaterMaker Font='' Width='20' Italic='false' Bold='false' Rotate='' HFlag='left' VFlag='top' XPos='50' YPos='50' Color='#ff0000' Trans='0' Range='' tile-full='false'>OFD文档水印测试</WaterMaker>
addWaterImageAnnot	添加图片水印	执行修改参数水印相关信息 {"image":"D:/tmp/1.png","vflag":"top","hflag":"left","pos-x":"10","pos-y":"10","rotate":"0","gray":"false","scale":"100","range":"all","tile-full":"true"}
delWaterMakerAnnot	删除文档水印	执行修改参数用户标识是否删除所有水印
delWaterMakerAnnotByID	根据Id删除水印	执行修改参数要删除的水印id
SetWatermarkForDownloadFile	设置下载水印	执行修改参数水印类型水印相关信息
setSafeWatermarkInfo	设置隐写水印信息	执行修改参数水印类型水印相关信息水印类型水印相关信息
addSafeWatermarkToFile	嵌入隐写水印到文档中（改变文档）	执行
getSafeWatermarkResult	获取隐写嵌入结果	执行修改参数查询类型
setServiceAddr	设置服务地址	执行修改参数服务器的Key 服务器的URL
setLogSvrURL	设置日志服务地址	执行修改参数服务器地址
setLogSvrAddr	设置日志服务地址	执行修改参数服务器地址
setContentSvrAddr	设置内容服务地址	执行修改参数服务器地址
setConvertSvrAddr	设置转换服务的地址	执行修改参数服务器地址
setUpdateSvrAddr	设置更新服务的地址	执行修改参数服务器地址
setConfigInfo	设置配置信息（运行时）	执行修改参数配置项配置值
saveConfigInfoToIni	保存配置信息	执行修改参数配置项配置值
addAffixAnnot	插入署名章	执行修改参数图片相关信息
AddAffixByInfo	添加署名章（自定义）	执行修改参数署名章信息
importSignatureImage	添加人名章	执行修改参数章信息 {"img-path":"F:/Signature/test1.png","date-format":"3","time-format":"2","font-family":"宋体","font-size":"20","font-style":"false","font-weight":"true","font-color":"#ff0000","sign-issameline":"false","align-style":"alignleft"}
setCommentsSignInfo	文本批注署名落款信息	执行修改参数署名/落款信息测试数科
setFreqUsedComments	设置文本框常用意见	执行修改参数意见信息
getPageCount	获取文档页面总数	执行
getOpenPageCount	根据文件名获取页数	执行修改参数文件路径
getForegroundColor	获取阅读器前景颜色	执行
editCopy	拷贝选定内容	执行
setClipboardMonitor	设置监视并清空剪切板	执行修改参数是否清空
isDocumentModified	获取组件中当前在阅读状态的文档打开后的修改状态	执行
isDocumentModifiedAfterOpen	获取当前文档是否处于编辑状态	执行
getCurrentPageIndex	获取当前页面索引	执行
downloadHttpFile	异步下载文件	执行修改参数远程文件路径要保存到本地的文件全名 md5值
downloadFile	下载安全文件	执行修改参数下载文件的本地保存地址离线安全文件参数 <actioninfo type="f_downloadenv"><parameter name="user.password" value="123123"/></actioninfo>
setEncryptTempFile	设置是否对下载的远程文件加密	执行修改参数是否加密
convertFile	转换文件	执行修改参数转换前文件的路径转换后文件的路径自定义元数据 <MetaRoot xs:SchemaLocation="metadata.xsd" xmlns:xs="http://www.w3.org/2001/ XMLSchema - instance"><DocID>8dd2AC6AA23946E39F845DB77E795DFC</DocID><Title>江苏国土资源厅组织基本耕地保护调查</Title><Author>谢宗凡</Author><Subject>土地管理</Subject><Abstract>江苏国土资源厅组织在苏州无锡等地进行耕地保护调查</Abstract><ModDate>2013-02-14</ModDate><DocUsage>magzine</DocUsage><Keywords><Keyword>江苏</Keyword><Keyword>调查</Keyword><Keyword>基本耕地保护</Keyword></Keywords><CustomDatas><CustomData Name="Url">http://1.com/20130214/1.shtml</CustomData>
addPageAnnot	添加注释	执行修改参数注释信息
getAnnotAmountBy	获取注释数量	执行修改参数注释的信息
getAnnotInfoBy	获取注释信息	执行修改参数注释的信息
getSignaturePenAnnotImageBy	获取注释图片	执行修改参数注释的信息 {"userid":"","datatag":"","range":"1-2"}
getAnnotIdsByInfo	获取区域内注释信息	执行修改参数指定区域 {"type":"","userid":"","datatag":"","starttime":"","endtime":"","page-index":"1-2","pos-x":"","pos-y":"","width":"","height":""}
copyAnnotsToPos	粘贴注释到指定位置	执行修改参数指定区域
setRevisionRemarkById	修改修订注释的备注信息	执行修改参数 ids 备注内容信息
setRevisionHighLightById	设置高亮	执行修改参数 ids
deleteAnnotationByParameter	清除注释	执行修改参数注释的信息
DeleteAnnotById	根据id删除注释	执行修改参数注释ID
setTabletWidth	设置手写板粗细	执行修改参数手写板粗细
setTabletColor	设置手写板颜色	执行修改参数手写板颜色
getHandWrittenAnnotAnnotByID	获取手写签批信息	执行修改参数手写签批注释ID
clearHandwrittenAnnotation	清空手写/图型批注	执行修改参数手写批注类型
gotoDest	跳转至指定位置	执行修改参数页面的索引值（从1开始） x位置 y位置
gotoDestArea	跳转到指定视图区域	执行修改参数视图区域
getPageView	跳转至页面指定位置	执行修改参数页面的索引值（从1开始） left的起始位置 top的起始位置
InsertPage	插入页面	执行
InsertPage2	插入页面(指定插入页面的相关信息)	执行修改参数页面的相关信息 {"filename":"D:/tmp/savefile.ofd","pagecount":"1","pagerange":"1","pagenumber":"1","pagedirect":"after"}
InsertBlankPage	插入空白页	执行修改参数页面的相关信息 {"pagenumber":"1","pagedirect":"after"}
DeletePage	删除页面	执行修改参数页面的相关信息
GetPageWidth	获取页面宽	执行修改参数页面索引
GetPageHeight	获取页面高	执行修改参数页面索引
excuteOperation	执行xml动作	执行修改参数功能和参数
importSinemaTemp	导入语义模板	执行修改参数导入文件名称
setWindowNotOnTop	设置阅读器为顶端显示	执行
setRegistrationInfo	注册高级版	执行修改参数项目名称数科生成的注册码
GetReaderRegStatus	获取阅读器注册状态	执行
addStampStream	添加橡皮图章	执行修改参数图片base64数据流
addStampAnnot	插入橡皮图章	执行修改参数图片相关信息 {"name":"测试图章","image":"D:/tmp/1.png","cx":"10","cy":"10","width":"10","height":"10","border-top":"10","border-left":"10","pages":"","applysign":"true","origin":"top-left"}
getStampAnnotName	获取所有橡皮图章名称	执行
SetKeepStampRatioParam	添加橡皮图章拉伸参数	执行修改参数是否保持等比例拉伸设置的宽度设置的高度
addStampUrl	添加远程橡皮图章地址	执行修改参数 url地址
addStampAnnotFromFile	通过图片信息添加橡皮图章	执行修改参数图片名称或数据信息
SetNotDrawdragControl	设置橡皮图章控制点参数	执行修改参数不绘制的控制点参数
setSignatureExtensionData	设置签章扩展数据	执行修改参数应用标识名称签章ID 扩展数据
exportImage	导出图片接口	执行修改参数设置欲导出图片的json格式 {"range":"3-5","dpi":"96","format":"jpg","dir":"D:/tmp/"}
ExportPdfFile	导出PDF文件	执行修改参数 pdf文件保存路径设置欲导出图片的json格式
DistillPageAsTxt	提取页面为txt文件	执行修改参数指定提取页面参数 {"range":"all", "subrange":"all", "distillfilename":"D:/tmp/distillPageAsTxt.txt"}
ZoominBoundary	放大矩形区域	执行修改参数参数信息 {"page-index":"1","pos-x":"50","pos-y":"50","width":"50","height":"50"}
updateViewCache	更新文档视图缓存	执行修改参数更新文档视图方式
setDateFormat	设置日期章格式	执行修改参数日期章格式 {"date-format":"2018年12月27日","font-family":"宋体","font-size":"16","font-style":"true","font-weight":"true","font-color":"#000000"}
writeDateText	添加日期章	执行
cancelWriteDateText	取消鼠标日期章状态	执行
deleteLocalFile	删除本地文件	执行修改参数要删除的本地文件路径
uploadLocalFile	上传本地文件	执行修改参数接收文件上传的servlet 待上传本地文件路径
deleteLocalDir	删除本地目录	执行修改参数本地的文件目录路径
renameLocalDir	修改本地目录	执行修改参数本地的文件目录重命名新目录
setSendtoInfo	设置右键菜单（选择文字）	执行修改参数配置字符串 <menuitem action="menu_f_open" icon="icon20/OpenFile.svg" text="打开11(& O)"/>
SetContextMenuStripEnable	设置右键菜单可用	执行修改参数菜单名称是否可用
SetContextMenuStripVisible	设置右键菜单可见	执行修改参数菜单名称是否可见
AddBookmark	添加书签	执行修改参数添加书签类型
getBookmarkInfo	获取书签信息	执行
RenameBookmark	重命名书签	执行修改参数原始名称待修改名称
LocationBookmarkbyName	跳转至书签	执行修改参数书签名称
getBookmarkBoundaryByName	获取书签的boundary信息	执行修改参数书签名称
mergeInfoToOneFile	导入书签	执行修改参数原ofd文件和目标ofd文件
DeleteBookmarkbyName	删除书签	执行修改参数要删除的书签名称
ExportAttachment	导出附件	执行修改参数本地存放附件的路径是否弹出提示
ImportAttachment	导入附件	执行修改参数本地存放附件的路径附件中的子文件夹附件是否可见
convertFileFromBase64PDF	PDF转换OFD	执行修改参数文件base64数据流信息保存文件路径
getSearchResultAmount	获取文档关键字	执行修改参数关键字全词匹配区分大小写
SetScreenshotsEnable	截屏控制接口	执行修改参数是否允许截屏要禁止的程序进程名字
ExcuteOutlineAction	执行大纲动作	执行修改参数大纲节点数据
ExportOutline	导出执行大纲	执行
ColorCorrectionByRect	区域校色	执行修改参数校色域
version	获取阅读器版本	执行
getLogFilePath	获取日志文件路径	执行
getLocalHostName	获取本地计算机名	执行
setReaderRect	设置阅读器的位置和大小	执行修改参数 x坐标 y坐标宽度高度
getReaderRect	获取阅读器位置大小	执行
GetCustomTagID	获取公文域ID	执行修改参数公文域的ID
DeleteCustomTagContentbyID	删除公文域ID对应的内容	执行修改参数公文域的ID
IsOfdFileConvertTxt	判断是否为ofd文件,是否转换为txt	执行修改参数参数
getFileMd5Value	获取文件的MD5哈希值	执行
addFileToDelete	添加待删除文件接口	执行修改参数待删除文件名
copyFileToDestination	拷贝文件	执行修改参数原文件路径复制到
getUserTempDir	获取用户临时目录	执行
deleteFileByPath	删除临时目录下文件	执行修改参数待删除路径
setTitleForOpenedURLFile	设置打开的远程文件名称	执行修改参数文件名称
InsertPageByParam	插入页面(指定插入页面的相关信息)	执行修改参数页面的相关信息 {"filename":"","pagecount":"","pagerange":"1-5","pagenumber":"","pagedirect":""}
GetPageRevisionItemCount	获取批注数接口	执行修改参数指定页面 {"type":"All","pageindexs":""}
modifyFreeTextFontInfo	修改文本框字体信息	执行修改参数描述信息
setExit	设置是否退出阅读器	执行修改参数是否退出阅读器
getIPMacAddress	获取IP和MAC地址	执行
showPromptInfoByParams	给操作前增加是否继续执行的提示	执行修改参数描述信息
implantContentToDoc	嵌入文档	执行修改参数描述信息

SuwellOFD JSAPI单接口示例