ONLYOFFICE⽂档服务器使⽤介绍
ONLYOFFICE⽂档服务器使⽤介绍
1.ONLYOFFICE构建页⾯:
<!DOCTYPE html>
<html lang="zh">
<head>
<meta chart="UTF-8">
<title>测试</title>
<script type="text/javascript" src="⽂档服务器IP：端⼝/web-apps/apps/api/documents/api.js"></script>
<style>
html {
height: 100%;
width: 100%;
padding: 0;
margin: 0;
}
body {
height: 100%;
width: 100%;
padding: 0;
margin: 0;
}
</style>
</head>
<body>
<div id="placeholder" class="nav" ></div>
<script language="javascript" type="text/javascript">
var docEditor = new DocsAPI.DocEditor("placeholder", config);
</script>
</body>
</html>
2.ONLYOFFICE构建参数介绍
可以为ONLYOFFICE Document Server更改的参数可以细分为以下主要部分：
允许更改使⽤的平台类型，⽂档显⽰⼤⼩（宽度和⾼度）以及打开的⽂档类型；
· 包含与⽂档有关的所有参数（标题，URL，⽂件类型等）；
o 包含⽂档的其他参数（⽂档所有者，⽂档存储⽂件夹，上传⽇期，共享设置）；
o -定义是否可以编辑和下载⽂档；
· 定义与编辑器界⾯有关的参数：打开模式（查看器或编辑器），界⾯语⾔，其他按钮等）；
o -允许⾃定义编辑器界⾯，使其看起来像您的其他产品（如果有），并更改是否存在其他按钮，链接，更改徽标和编辑者所有者详细信息；
o -仅⽤于嵌⼊式⽂档类型，并允许更改⽤于控制嵌⼊式模式的按钮的⾏为；
· - ⽤于将必要的连接到您的Document Server，以便对所有⽂档编辑器⽤户可见；
· -是在将某些操作应⽤于⽂档时（加载，修改等时）调⽤的特殊事件的列表；
let config = {
"document": {
"documentType": "text",
"width": "100%", //打开窗⼝宽度
"height": "100%", //打开窗⼝⾼度
"fileType": "doc",//⽂档类型
"key": "618", //定义⽤于服务识别⽂档的唯⼀⽂档标识符。每次编辑和保存⽂档时，都必须重新⽣成密钥。长度限制为128个符号。
"title": "1.doc", //为查看或编辑的⽂档定义所需的⽂件名，该⽂件名也将在下载⽂档时⽤作⽂件名。长度限制为128个符号。
"url": "/downLoad/618", //定义存储原始查看或编辑的⽂档的绝对URL
"info": {
"owner": "王重阳",//⽂件创建者名称
"sharingSettings": [//⽂件对应⽤户的操作权限配置
{
"permissions": "Full Access", // 完全操作权限-Full Access，只读权限-Read Only 拒绝访问-Deny Access
"ur": "林朝英" //有次权限的⽤户
},
{
"permissions": "Read Only",
"ur": "周伯通"
},
],
"uploaded": "2010-07-07 3:46 PM" //⽂件创建时间
},
//⽂档权限参数
"permissions": {
"edit": true, //（⽂件是否可以编辑，fal时⽂件不可编辑）
"fillForms": true,//定义是否能在⽂档中填充表单
"print": fal, //定义⽂档是否能打印
"review": fal,//第⼀是否显⽰审阅⽂档菜单
"comment": true, //定义是否可以注释⽂档。如果注释权限设置为“ true”，则⽂档侧栏将包含“注释”菜单选项；只有将mode参数设置为edit时才⽣效，默认值与edit参数的值⼀致。
"copy": true, //是否允许您将内容复制到剪贴板。默认值为true。
"download": true, //定义是否可以下载⽂档或仅在线查看或编辑⽂档。如果下载权限设置为“fal”下载为菜单选项将没有。默认值为true。
"modifyContentControl": true, //定义是否可以更改内容控件设置。仅当mode参数设置为edit时，内容
控件修改才可⽤于⽂档编辑器。默认值为true。
"modifyFilter": true, //定义过滤器是否可以全局应⽤（true）影响所有其他⽤户，或局部应⽤（fal），即仅适⽤于当前⽤户。如果将mode参数设置为edit，则过滤器修改仅对电⼦表格编辑器可⽤。默认值为true。 }
},
// type: "embedded",
//打开⽂档类型
// text对应各种⽂档类型(.doc, .docm, .docx, .dot, .dotm, .dotx, .epub, .fodt, .htm, .html, .mht, .odt, .ott, .pdf, .rtf, .txt, .djvu, .xps)
//spreadsheet对应表格类型(.csv, .fods, .ods, .ots, .xls, .xlsm, .xlsx, .xlt, .xltm, .xltx)
//prentation对应PPT类型(.fodp, .odp, .otp, .pot, .potm, .potx, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx)5寸有多大
"editorConfig": {//编辑配置
"createUrl": "docServer:port/url-to-create-document/", //指定创建⽂件的页⾯，添加该配置后⽂档服务器插件才会显⽰新建⽂件按钮
"mode": "view", //⽂档操作模式 view 视图模式不可编辑 edit 编辑模式可编辑⽂档
"callbackUrl": "/out/docx/save",//保存⽂件时的回调地址
"lang": "zh-CN", //语⾔环境
"customization": {//定制部分允许⾃定义编辑器界⾯，使其看起来像您的其他产品，并更改是否存在其他按钮，链接，更改徽标和编辑者所有者详细信息。
"help": true, //定义是显⽰还是隐藏“帮助”菜单按钮。默认值为true。
"hideRightMenu": fal, //定义在第⼀次加载时是显⽰还是隐藏右侧菜单。默认值为fal。
"autosave": true,//定义是启⽤还是禁⽤“⾃动保存”菜单选项。请注意，如果您在菜单中更改此选项，它将被保存到浏览器的localStorage中。默认值为true。
个人主页设计
"forcesave": true, //定义保存按钮是否显⽰默认fal
"chat": true, //定义“聊天”菜单按钮是显⽰还是隐藏；请注意，如果您隐藏“聊天”按钮，则相应的聊天功能也将被禁⽤。默认值为true。
"commentAuthorOnly": fal, //定义⽤户是否只能编辑和删除他的评论。默认值为fal。
"comments": true, //定义是显⽰还是隐藏“注释”菜单按钮；请注意，如果您隐藏“评论”按钮，则相应的评论功能将仅可⽤于查看，评论的添加和编辑将不可⽤。默认值为true。
"compactHeader": fal, //定义是否将菜单栏放在在徽标旁边使界⾯更加紧凑默认fal。
"compactToolbar": fal, //定义显⽰的顶部⼯具栏类型是完整（fal）还是紧凑true。默认值为fal 多余菜单将在右侧折叠点击显⽰。
"compatibleFeatures": fal, //定义仅与OOXML格式兼容的功能的使⽤。例如，不要在整个⽂档上使⽤注释。默认值为fal。
"macros": true, //定义是否将运⾏⽂档宏以及可⽤的宏设置。默认值为true。
"macrosMode": "warn", //定义是否将运⾏⽂档宏。可以采⽤以下值： disable -根本不运⾏；enable -⾃动运⾏所有宏；warn -警告宏并请求允许运⾏。默认值为original。
"plugins": true, //定义是否将启动插件并可⽤。默认值为true。
"showReviewChanges": fal, //定义在加载编辑器时是否⾃动显⽰或隐藏审阅更改⾯板。默认值为fal。
"spellcheck": true, //定义在加载编辑器时是否⾃动打开或关闭拼写检查器。拼写检查器仅适⽤于⽂档编辑器和演⽰⽂稿编辑器。默认值为true。
"toolbarNoTabs": fal, //定义是突出显⽰顶部⼯具栏选项卡样式。默认值为fal。
"unit": "cm", //定义在标尺和对话框中使⽤的度量单位。可以采⽤以下值：cm -厘⽶，pt-点，inch -英⼨。默认值为厘⽶（cm）。
"zoom": 100, //定义以百分⽐为单位的⽂档显⽰缩放值。可以取⼤于0的值。对于⽂本⽂档和演⽰⽂稿，可以将此参数设置为-1（使⽂档适合页⾯选项）或-2（使⽂档页⾯宽度适合编辑器页⾯）。默认值为100。
"customer": { //关于⽂档编辑器的显⽰信息
"address": "My City, 123a-45", //有权访问编辑或编辑作者的公司或个⼈的邮政地址，
"info": "Some additional information", //有关您希望其他⼈认识的公司或个⼈的⼀些其他信息，
"logo": "/logo-big.png", //图⽚徽标的路径（此⽂件没有特别建议，但是如果使⽤透明背景的.png格式会更好）。图⽚必须具有以下尺⼨：432x70，
"mail": "", //有权访问编辑者或编辑者的公司或个⼈的电⼦邮件地址
"name": "欧阳锋", //该公司或个⼈的谁可以访问编辑或编辑作者，名称
"www": "" //以上公司或个⼈的家庭⽹站地址，
},
"feedback": { //反馈配置信息
"url": "", //单击“反馈和⽀持”菜单按钮时将打开的⽹站地址的绝对URL ，
"visible": true //显⽰或隐藏“反馈和⽀持”菜单按钮，
},
"goback": { //定义“打开⽂件位置”菜单按钮和右上⾓按钮的设置。该对象具有以下参数：
"blank": true, //在新的浏览器选项卡/窗⼝（如果值设置为true）或当前选项卡（如果值设置为fal）中打开⽹站。默认值为true，
"requestClo": fal, //定义如果单击“打开⽂件位置”按钮，则调⽤RequestClo事件，⽽不是打开浏览器选项卡或窗⼝。默认值为fal，
"text": "Open file location", //将在“打开⽂件位置”菜单按钮和右上⾓按钮（即，⽽不是“转到⽂档”）上显⽰的⽂本，
"url": "" //单击“打开⽂件位置”菜单按钮时将打开的⽹站地址的绝对URL ，
},
结算协议书范本"logo": {
"image": "/logo.png", //图像⽂件的路径，⽤于在普通⼯作模式下显⽰（即，在所有编辑器的查看和编辑模式下）。图⽚必须具有以下尺⼨：172x40，古罗马竞技场
"imageEmbedded": "/logo_em.png", //⽤于以嵌⼊式模式显⽰的图像⽂件的路径（请参阅config部分以了解如何定义嵌⼊式⽂档类型）。图⽚必须具有以下尺⼨：248x40，
"url": "" //某⼈单击徽标图像时将使⽤的绝对URL（可⽤于转到您的⽹站等）。保留为空字符串或null以使徽标不可单击，
},
},
"ur": { //⽤户信息
"id": "78e1e841",//⽤户ID
"name": "洪七公" //⽤户全名称
},
"embedded": { //Embedded部分仅适⽤于嵌⼊式⽂档类型（请参阅config部分以了解如何定义嵌⼊式⽂档类型）。它允许更改设置，这些设置定义嵌⼊式模式下按钮的⾏为。
"embedUrl": "/embedded?doc=exampledocument1.docx", //定义⽂档的绝对URL，以作为嵌⼊到⽹页中的⽂档的源⽂件
"fullscreenUrl": "/embedded?doc=exampledocument1.docx#fullscreen", //定义将以全屏模式打开的⽂档的绝对URL。
"saveUrl": "/download?doc=exampledocument1.docx", //定义允许将⽂档保存到⽤户个⼈计算机上的绝对URL。
"shareUrl": "/view?doc=exampledocument1.docx", //定义允许其他⽤户共享此⽂档的绝对URL。
"toolbarDocked": "top" //定义嵌⼊式查看器⼯具栏的位置，可以为top或bottom。
}
},
"events": { //事件配置
// onAppReady,//-将应⽤程序加载到浏览器时调⽤的函数。
// onCollaborativeChanges //-当⽂档由其他⽤户在严格共同编辑模式下共同编辑时调⽤的函数。
/
/ onDocumentReady,//-将应⽤程序加载到浏览器时调⽤的函数。
// onDocumentStateChange,//-修改⽂档时调⽤的函数。这就是所谓的使⽤参数：{真正的“数据”}在当前⽤户编辑⽂档以及与参数：{“数据”：假}在当前⽤户的更改发送到⽂档编辑服务。
// onDownloadAs,//-调⽤downloadAs⽅法时，使⽤指向已编辑⽂件的绝对URL调⽤的函数。在data参数中发送要下载的⽂档的绝对URL 。
// onError,//-发⽣错误或其他特定事件时调⽤的函数。错误消息在data参数中发送。
// onInfo,//-应⽤程序打开⽂件时调⽤的函数。该模式在de参数中发送。可以查看或编辑。
// onMetaChange,//-通过meta命令更改⽂档的元信息时调⽤的函数。⽂档名称通过data.title参数发送。
// onOutdatedVersion,//-使⽤旧的document.key值打开⽂档进⾏编辑时，显⽰错误后调⽤的函数，该值⽤于编辑先前的⽂档版本并已成功保存。调⽤此事件时，必须使⽤新的document.key重新初始化编辑器。
// onReady,//-将应⽤程序加载到浏览器时调⽤的函数。⾃从5.0版本不推荐使⽤，请使⽤onAppReady代替
// onRequestClo,//-结束编辑器的⼯作并且必须关闭编辑器时调⽤的函数。
// onRequestCompareFile,//-⽤户尝试通过单击“存储中的⽂档”按钮来选择要⽐较的⽂档时调⽤的函数。要选择要⽐较的⽂档，必须调⽤tRevidFile⽅法。如果未声明该⽅法，则不会显⽰“来⾃存储的⽂档”按钮。
// onRequestCreateNew,//-⽤户尝试通过单击“新建”按钮来创建⽂档时调⽤的函数。使⽤此⽅法代替createUrl字段。如果未声明该⽅法且未指定createUrl，则将不会显⽰“创建新”按钮。
// onRequestEditRights,//-⽤户尝试通过单击“编辑⽂档”按钮尝试将⽂档从视图切换到编辑模式时调⽤的函数。调⽤该函数时，必须在编辑模式下再次初始化编辑器。如果未声明该⽅法，则不会显⽰“编辑”按钮。
// onRequestHistory,//-⽤户尝试通过单击“版本历史记录”按钮显⽰⽂档版本历史记录时调⽤的函数。要显⽰⽂档版本历史，您必须调⽤refreshHistory⽅法。如果未声明该⽅法和onRequestHistoryData⽅法，则不会显⽰“版本历 // onRequestHistoryClo,//-当⽤户尝试通过单击“关闭历史记录”按钮来查看⽂档版本历史记录时，试图调⽤该⽂档时调⽤的函数。调⽤该函数时，必须在编辑模式下再次初始化编辑器。如果未声明该⽅法，则不会显⽰“关闭历 // onRequestHistoryData,//-⽤户尝试单击⽂档版本历史记录中的特定⽂档版本时调⽤的函数。
萌妹子头像
// onRequestInrtImage,//-⽤户尝试通过单击“保存图像”按钮插⼊图像时调⽤的函数。图像插⼊的类型在参数data.c中指定。
// onRequestRename,//-⽤户尝试通过单击“重命名...”按钮重命名⽂件时调⽤的函数。
// onRequestRestore,//-⽤户单击版本历史记录中的“还原”按钮来还原⽂件版本时调⽤的函数。
// onRequestSaveAs,//-⽤户尝试通过单击“另存为...”按钮保存⽂件时调⽤的函数。⽂档的标题和要下载的⽂档的绝对URL在data参数中发送。如果未声明该⽅法，则不会显⽰“另存为...”按钮。
// onRequestSharingSettings,//-⽤户单击“更改访问权限”按钮来管理⽂档访问权限时调⽤的函数。必须调⽤tSharingSettings⽅法来更新有关允许与其他⽤户共享⽂档的设置的信息。如果未声明该⽅法，则不会显⽰“更改访问 // onRequestUrs,//-评论者可以选择要在评论中提及的其他⽤户时调⽤的函数。要设置⽤户列表，必须调⽤tUrs⽅法。
// onWarning,//-发⽣警告时调⽤的函数。警告消息在data参数中发送。
中药陈皮的作用"onDocumentStateChange" : onDocumentStateChange, //⽂档改变后的回调
"onDocumentReady" : onDocumentReady, //⽂档初始化准备好后的回调
},
};
3.ONLYOFFICE Docs转换服务介绍
1. 请求换换的服务通过HTTP POST请求使⽤ URL: ：端⼝/ConvertService.ashx
2.简单请求参数说明
//#简单请求参数⽰例:
{
"async": fal, //是否异步请求
"filetype": "docx", //⽂档格式 [必填项]
"key": "Khirz6zTPdfd7", //[必填项]
"outputtype": "pdf", //需要转换的格式 [必填项]
"url": "/url-to-example-document.docx" //或者需要转换的⽂档的URL
}
//#请求参数⽰例
{
"filetype": "xlsx",
"key": "Khirz6zTPdfd7",
"outputtype": "pdf",
"region": "en-US",
"spreadsheetLayout": {
空调内机"ignorePrintArea": true,
"orientation": "portrait",
"fitToWidth": 0,
"fitToHeight": 0,
"scale": 100,
"headings": fal,
"gridLines": fal,
"pageSize": {
"width": "210mm",
"height": "297mm"
},
"margins": {
"left": "17.8mm",
"right": "17.8mm",
"top": "19.1mm",
"bottom": "19.1mm"
}
},
"title": "Example Document Title.pdf",
"url": "/url-to-example-spreadsheet.xlsx"
}
3.请求详细参数说明
参数描述类型是否必填
async定义转换请求类型：是否异步。true 是 fal 否boolean可选
codePage 定义从csv或txt格式转换时的⽂件编码主要⽀持的值：
932-⽇⽂（Shift-JIS）
950-中国传统（Big5）
1250-中欧(WINDOWN)
1251-西⾥尔⽂（Windows）
65001 -Unicode（UTF-8）
integer可选
delimiter 定义⽤于从csv格式转换时分隔值的定界符⽀持的值:
0-⽆分隔符
1-TAB 标签
2-分号integer可选
3-冒号
4-逗号
5-空格
filetype*定义要转换的⽂档⽂件的类型string required key定义⽤于明确标识⽂档⽂件的⽂档标识符string required outputtype*定义结果转换后的⽂档类型string required password定义⽂档⽂件的密码（如果使⽤密码保护）string可选
region从Spreadsheet格式转换为pdf时，定义货币，⽇期和时间的默认显⽰格式。使⽤四个字母（en-US，fr-FR等）的语⾔
代码设置。默认值为en-US
string可选spreadsheetLayout定义⽤于将电⼦表格转换为pdf的设置object可选spreadsheetLayout.fitToHeight设置转换区域的⾼度，以页数为单位。默认值为0integer可选spreadsheetLayout.fitToWidth设置转换区域的宽度，以页数为单位。默认值为0integer可选idLines是否允许将⽹格线包含到输出PDF⽂件中。默认值为fal boolean可选spreadsheetLayout.headings是否允许将标题包含在输出的PDF⽂件中。默认值为fal boolean可选s
preadsheetLayout.ignorePrintArea确定是否忽略为电⼦表格⽂件选择的打印区域。默认值为true boolean可选spreadsheetLayout.margins设置输出PDF⽂件的页边距object可选spreadsheetLayout.margins.bottom设置输出PDF⽂件的底边距。默认值为19.1mm string可选spreadsheetLayout.margins.left设置输出PDF⽂件的左边距。默认值为17.8mm string可选spreadsheetLayout.margins.right设置输出PDF⽂件的右边距。默认值为17.8mm string可选p设置输出PDF⽂件的上边距。默认值为19.1mm string可选ientation设置输出PDF⽂件的⽅向。可能是风景，肖像。默认值为portrait string可选spreadsheetLayout.pageSize设置输出PDF⽂件的页⾯⼤⼩object可选spreadsheetLayout.pageSize.height设置输出PDF⽂件的页⾯⾼度。默认值为297mm.string可选spreadsheetLayout.pageSize.width设置输出PDF⽂件的页⾯宽度。默认值为210mm string可选spreadsheetLayout.scale允许设置输出PDF⽂件的⽐例。默认值为100。integer可选thumbnail指定的图像格式（当定义⽤于缩略图的设置BMP，GIF，JPG，PNG）作为输出类型.object可选thumbnail.aspect定义模式以使图像适合指定的⾼度和宽度。⽀持的值：.integer可选
thumbnail.first
0-拉伸⽂件以适合⾼度和宽度，
1-保留图⽚的外观，
2-在这种情况下，不使⽤宽度和⾼度设置。取⽽代之的是，将页⾯的度量标准尺⼨转换为96dpi的像素。例
如，A4（210x297mm）页⾯将变成⼀张794x1123pix尺⼨的图⽚。定义是只为⾸页还是为所有⽂档页⾯⽣成缩略图。
如果为fal，则将创建包含所有页⾯缩略图的zip存档。
默认值为true,
boolean可选
thumbnail.height默认值为2定义缩略图⾼度（以像素为单位）。默认值为100。.integer可选thumbnail.width定义缩略图的宽度（以像素为单位）。默认值为100。integer可选title定义转换后的⽂件名。string可选
token定义以形式添加到Document Server配置的加密签名。string配置后
必填url定义要转换的⽂档的绝对URL。string可选
参数描述类型是否必填
4.响应结果说明:
//正常响应结果
{
"endConvert":true，//转换是否完成
"fileUrl"：“ https：//documentrver/ResourceService.ashx?filename=output.doc”，//转换后的⽂件地址
"percent"：100//转换完成百分⽐仅参数设置为异步时
}
//异常响应结果
{
“error”：- 3
}
bbc英语听力
5.错误码说明:
错误代码描述
-1未知错误。
-2转换超时错误。
-3转换错误。
-4下载要转换的⽂档⽂件时出错。
-5密码错误。
-6访问转换结果数据库时出错。
-7输⼊错误。
-8令牌⽆效。
⽂档转换表格:
⽂档类型转换表格:
表格类型转换表格:
演⽰⽂稿PPT转换表格:
