SDK 简介
SDK提供了丰富的 API 对各类文档进行操作,通过使用 SDK,网页开发者可以自定义文档界面的元素、操作文档的内容、监听文档事件等操作,SDK 为用户提供了优质的在线文档体验。
接入方需要通过引入 SDK, 生成 WebOffice 文档的 iframe
元素,将在线文档页面在宿主网页中展示出来。接入方网页和 WebOffice 文档、SDK 之间的通信过程如下:
SDK 能做什么
开发者在引入并成功初始化 SDK 后,便可以使用 SDK
实例来帮助您完成文档相关的需求了。实例主要包含四个方面的能力:
- 在您的业务网页内显示 WebOffice 文档
- 通过在初始化时(调用WebOfficeSDK.init()函数时)灵活传递初始化配置,可以自定义文档界面、获取页面状态等
- 通过ApiEvent对象对文档的各类事件进行监听
- 通过Application对象对文档进行丰富的 API 调用,直接对文档的内容、格式和图形等进行操作变换
SDK 1.0 版本和3.0 版本 有什么区别
- JSSDK 1.0 通过 iframe 技术加载在线文档,有着更广泛的应用场景和丰富的功能适配
- JSSDK 3.0 版本通过 微前端 技术加载在线文档,有着跟客户系统一体化的体验
集成效果
1. SDK 1.0 版本
在智能文档场景下,借助 SDK 1.0 版本嵌入 WPS多维表格 的效果展示如下:
特点:
- 直接加载已有的云文档链接,WPS多维表格的交互被限定于既定视图区域内,无法超出区域。
- 通常情况下,文档内部划定一大块区域,用于加载类知识库内容,以此实现与业务系统的融合。
2. SDK 3.0 版本
在智能文档场景下,借助 SDK 3.0 版本嵌入 WPS多维表格 的效果展示如下:
特点:
- WPS多维表格以嵌入形态融入文档,与业务系统紧密贴合,为用户提供一体化的交互体验,操作更为流畅。
具体接入可以查看快速入门