调用方法

JS API 是 OfficeSDK 提供的一组 JavaScript 接口，封装在编辑器实例中。
接入方在调用 createSDK() 初始化 SDK 后，可获取编辑器实例，并基于该实例使用 JS API 与文档进行双向通信。

这些 API 由 SDK 统一代理封装，接入方无需了解底层的消息传输协议和浏览器安全策略，便可直接对嵌入式文档发起控制命令或获取状态信息。

文档类型与接口划分

JS SDK 会根据所加载的文档类型（如文字、表格或演示）返回对应的编辑器实例，并暴露其专属的 API 接口。开发者可按需调用这些接口与内容交互。

标题	编辑器实例类型	支持能力范围（示例，详见各章节）
文字	Document	获取选区、获取目录、插入段落等
电子表格	Spreadsheet	获取工作表、获取单元格等
演示	Presentation	获取幻灯片、获取幻灯片索引等
PDF	Pdf	获取选区、获取页码、获取目录等

前提：初始化 OfficeSDK 实例

参考《在线预览编辑服务 - 前端 SDK》章节，引入 JS SDK，并初始化 OfficeSDK 实例。

import { createSDK } from '@officesdk/web'

function async loadSDK() {

  // 获取 sdk 实例
  const sdk = createSDK({
    endpoint: 'https://office-sdk-endpoint/'
    token: '识别用户请求的 token',
    fileId: '系统中的 file id',
    fileType: FileType.Document,
    root: document.getElementById('sdk'),
    lang: 'en-US' // 未指定此参数时，使用浏览器默认语言
  });
}

第 1 步：获取编辑器实例

调用 connect() 方法，获取编辑器实例。

  // 获取编辑器实例
  const document = await sdk.connect();

第 2 步：调用 API

调用相应文档类型的 API，完成对编辑器内容的操作。

使用示例：初始化文字编辑器，并获取选区内容。

import { createSDK } from '@officesdk/web'

function async loadSDK() {
  // 获取 sdk 实例
  const sdk = createSDK({
    endpoint: 'https://office-sdk-endpoint/'
    token: '识别用户请求的 token',
    fileId: '系统中的 file id',
    fileType: FileType.Document,
    root: document.getElementById('sdk'),
    lang: 'en-US' // 未指定此参数时，使用浏览器默认语言
  });
  
  // 获取编辑器实例
  const document = await sdk.connect();
  
  // 调用编辑器相关方案
  const range = await document.Selection().getRange();
  ...
}

调用方法

文档类型与接口划分#

调用方法#

前提：初始化 OfficeSDK 实例#

第 1 步：获取编辑器实例#

第 2 步：调用 API#

文档类型与接口划分

调用方法

前提：初始化 OfficeSDK 实例

第 1 步：获取编辑器实例

第 2 步：调用 API