您可以通过文档在线预览功能在线预览文档。本文介绍文档在线预览处理功能参数及示例。
使用场景
企业知识库或文档管理系统:在企业的内部知识库或者文档管理系统中,员工上传的Word、Excel、PPT等文件可以转化为网页可展示的格式,实现无需下载即可在线查看,有利于提高信息查阅效率及数据安全性。
在线教育平台:教育平台可以利用此功能为学生提供教材、讲义、作业等各种教学资料的在线预览服务,方便师生随时随地查阅学习资料,增强互动性和用户体验。
协同办公与项目管理工具:在团队协作工具中,成员共享的工作计划、设计稿、报告文档等可通过OSS在线预览功能直接在浏览器中打开,无需下载,大大提升了团队间的沟通和协作效率。
注意事项
如果您需要通过x-oss-process使用文档在线预览,请在配额中心申请。
文档在线预览仅支持同步处理。关于文档预览更多信息请参见WebOffice服务交互流程。
使用文档在线预览前,需要先绑定IMM Project。关于控制台和API如何绑定,请参见快速入门和AttachOSSBucket。
不支持匿名访问。
必须拥有IMM处理所需的相关权限。更多信息,请参见权限。
文档在线预览操作需要您在OSS Bucket绑定自定义域名,通过自定义域名访问文件时才能打开预览。如果使用OSS默认域名访问文件,将下载文档预览HTML页面。关于绑定自定义域名更多信息,请参见绑定自定义域名至Bucket默认域名。
参数说明
操作名称:doc/preview
具体参数如下表所示。
参数名称 | 类型 | 是否必须 | 描述 |
int | 否 | 是否允许打印。取值:
| |
copy | int | 否 | 是否允许复制。取值:
|
export | int | 否 | 是否允许导出为PDF。取值:
|
maxpage | int | 否 | 最大渲染页数,取大于0的整数。 |
watermark | string | 否 | 水印参数。 |
text | string | 否 | 水印文字。需经过URL安全的Base64编码。具体操作,请参见水印编码。 父节点:watermark |
size | int | 否 | 水印文字字号,取大于0的整数。 父节点:watermark |
t | int | 否 | 水印文字透明度。取值范围:0~100。 默认值:100,表示透明度100%(不透明)。 父节点:watermark |
color | string | 否 | 水印文字颜色,RGB颜色值,例如:#000000表示黑色,#FFFFFF表示白色。 默认值为#FFFFFF。 父节点:watermark |
rotate | int | 否 | 指定文字顺时针旋转角度。取值范围:0~360。 默认值为0,表示不旋转。 父节点:watermark |
type | string | 否 | 指定文字水印的字体,需经过URL Safe的Base64编码。具体操作,请参见水印编码。 支持的字体如下:
父节点:watermark |
使用REST API
预览信息
预览文档名称:example.docx
预览页面:文档前3页
预览页面水印信息:
水印类型:文字水印
水印文字:内部资料
水印字号:30号字体
水印透明度:60
预览页面权限信息:
允许用户复制
允许用户导出
允许用户打印
处理示例
GET /exmaple.docx?x-oss-process=doc/preview,export_1,print_1/watermark,text_5YaF6YOo6LWE5paZ,size_30,t_60 HTTP/1.1
Host: doc-demo.oss-cn-hangzhou.aliyuncs.com
Date: Fri, 28 Oct 2022 06:40:10 GMT
Authorization: OSS qn6q**************:77Dv****************
使用SDK
文档在线预览仅支持同步处理,SDK使用方法请参见使用SDK。
常见问题
是否支持预览动态PPT中的动画和视频?
支持。在线预览功能最大支持200 MB的文档,超过200 MB则无法访问。
是否支持预览图片文件?
不支持。
- 本页导读 (1)