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

概述

JS SDK（JavaScript Software Development Kit）是为前端开发者提供的一套开发工具包，旨在帮助开发者将 OfficeSDK 的在线文档编辑和预览功能集成到自己的网页应用中。
通过 JS SDK，开发者无需依赖客户端，即可轻松将文档嵌入网页，实现对文档内容的查看、编辑、保存等操作。

为什么需要 JS SDK？#

JS SDK 提供了多种能力，帮助开发者实现在线文档的预览与编辑：
初始化 iframe 并显示文档：将文档直接嵌入网页中进行预览或编辑；
监听文档事件：开发者可以通过文档实例监听各种事件，及时作出响应；
通过 API 与文档内容交互：JS SDK 提供了一组强大的 API，允许开发者通过 API 对文档内容进行操作。

JS SDK 通讯过程概览#

image.png
核心组件定义
组件描述技术定位
接入方网页业务方承载编辑器的宿主页面Web 应用层
JS SDK提供编辑器容器管理能力的前端库桥接层
编辑器实例基于 SDK 创建的文档核心操作对象服务层
JS API接入方的文档操作接口集合接口层
修改于 2025-04-18 10:07:25
上一页
获取 AI 配置
下一页
接入流程
Built with