OfficeSDK 开发文档
  1. 前端 SDK
OfficeSDK 开发文档
  • ⭐️ 快速开始
    • 开始
    • 安装及部署
  • 💰 收费介绍
    • 定价
  • 📖 在线预览编辑服务
    • 原理概述
    • 支持格式
    • 场景举例
    • 接入流程
    • 服务端回调
      • 概述
      • 回调网关
      • 文档预览编辑
        • 文档预览接入流程
        • 文档编辑保存接入流程
        • 文档预览
          • 获取文件信息
          • 获取文件下载地址
          • 获取水印信息
        • 文档保存
          • 获取内容上传地址
          • 上传内容完成后,回调通知上传结果
        • 文档资源上传
          • 获取资源上传地址
          • 上传资源完成后,回调通知上传结果
        • 签发文档下载地址
        • 签发资源下载地址
      • 鉴权
        • 鉴权说明
        • 鉴权接口
      • 文档 AI
        • 文档 AI 启用流程
        • 获取 AI 配置
    • 前端 SDK
      • 概述
      • 接入流程
      • 实例对象
    • JS API
      • 调用方法
      • 总览
      • 公共
        • 文档内容(content)
      • 文字
        • 选区(selection)
        • 区域(range)
      • 表格
      • 幻灯片
      • PDF
        • 选区(selection)
        • 区域(range)
    • 后端 API
      • 文件下载
        • 创建下载任务
        • 获取下载进度
  • ⚙️ 控制后台
    • 概述
    • 后台管理
      • 系统管理
      • 回调配置
      • 字体管理
      • 日志管理
  • 📔 更新日志
    • V1.2
    • V1.1
  • ❓ 其他问题
    • 如何采集服务器机器码?
    • 如何实现集群部署?
  1. 前端 SDK

实例对象

在使用 Office SDK 时,调用 createSDK() 方法后,你将获得一个 SDK 实例对象。这个实例对象封装了与特定文件类型(如文字、电子表格、演示等)相关的属性和方法,提供开发者与 Office 文件的交互接口。本文档将介绍如何接入并使用这个 SDK 实例对象。

属性列表#

属性类型说明
urlstring获取当前 SDK iframe 加在的 URL
iframeHTMLElement获取当前 SDK iframe 的实例

方法列表#

方法说明
connect()加载编辑器实例
destroy()销毁当前 SDK 实例

connect()#

connect() 方法用于建立与 SDK 的连接并返回一个可操作的编辑器实例。该方法在调用 createSDK() 后使用,并通过返回的 SDK 实例来连接编辑器。成功连接后,开发者可以通过返回的编辑器实例进行文档操作,如获取选区、修改内容等。
使用示例:
  // 获取并连接编辑器实例
  const document = await sdk.connect();

destroy()#

当你不再需要使用 SDK 时,可以调用 destroy() 方法来销毁 SDK 实例。销毁实例后,相关的资源会被释放,避免内存泄漏。
使用示例:
sdk.destroy();
console.log('SDK 实例已销毁');
修改于 2025-04-17 09:43:35
上一页
接入流程
下一页
调用方法
Built with