WPS WebOffice

https://solution.wps.cn/docs/
Admin
WPS WebOffice is an open platform providing online document preview, editing, and collaborative...
Tokens:179,762
Snippets:1,627
Trust Score:9.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Convert Office to TXT Request Examples

Source: https://solution.wps.cn/docs/convert/to-txt.html

Examples of how to initiate an office-to-txt conversion task using various programming languages.

```javascript
const data = JSON.stringify({
	"url": "https://***.com/***",
	"filename": "说明文档.pdf",
	"long_txt": true
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
	if (this.readyState === this.DONE) {
		console.log(this.responseText);
	}
});

xhr.open("POST", "https://solution.wps.cn/api/developer/v1/office/convert/to/txt");
xhr.setRequestHeader("Date", "Wed, 23 Jan 2013 06:43:08 GMT");
xhr.setRequestHeader("Content-Md5", "d41d8cd98f00b204e9800998ecf8427e");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Authorization", "WPS-2:******:ac59dac1460772a04b3a97d7ef78409f28241e3a");

xhr.send(data);
```

```node.js
const http = require("https");

const options = {
	"method": "POST",
	"hostname": "solution.wps.cn",
	"port": null,
	"path": "/api/developer/v1/office/convert/to/txt",
	"headers": {
		"Date": "Wed, 23 Jan 2013 06:43:08 GMT",
		"Content-Md5": "d41d8cd98f00b204e9800998ecf8427e",
		"Content-Type": "application/json",
		"Authorization": "WPS-2:******:ac59dac1460772a04b3a97d7ef78409f28241e3a"
	}
};

const req = http.request(options, function (res) {
	const chunks = [];

	res.on("data", function (chunk) {
		chunks.push(chunk);
	});

	res.on("end", function () {
		const body = Buffer.concat(chunks);
		console.log(body.toString());
	});
});

req.write(JSON.stringify({url: 'https://***.com/***', filename: '说明文档.pdf', long_txt: true}));
req.end();
```

```c
CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "https://solution.wps.cn/api/developer/v1/office/convert/to/txt");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Date: Wed, 23 Jan 2013 06:43:08 GMT");
headers = curl_slist_append(headers, "Content-Md5: d41d8cd98f00b204e9800998ecf8427e");
headers = curl_slist_append(headers, "Content-Type: application/json");
headers = curl_slist_append(headers, "Authorization: WPS-2:******:ac59dac1460772a04b3a97d7ef78409f28241e3a");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"url\":\"https://***.com/***\",\"filename\":\"说明文档.pdf\",\"long_txt\":true}");

CURLcode ret = curl_easy_perform(hnd);
```

```csharp
var client = new RestClient("https://solution.wps.cn/api/developer/v1/office/convert/to/txt");
var request = new RestRequest(Method.POST);
request.AddHeader("Date", "Wed, 23 Jan 2013 06:43:08 GMT");
request.AddHeader("Content-Md5", "d41d8cd98f00b204e9800998ecf8427e");
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "WPS-2:******:ac59dac1460772a04b3a97d7ef78409f28241e3a");
request.AddParameter("application/json", "{\"url\":\"https://***.com/***\",\"filename\":\"说明文档.pdf\",\"long_txt\":true}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

--------------------------------

### Get Section Page Setup

Source: https://solution.wps.cn/docs/client/api/Word/Sections

Accesses the PageSetup object for a specific section to manage page properties.

```javascript
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取第 1 个节的页面属性，返回 PageSetup 对象
  const Section = await app.ActiveDocument.Sections.Item(1).PageSetup
}
```

--------------------------------

### StartPlay

Source: https://solution.wps.cn/docs/client/api/PDF/Sub

Registers a handler to listen for the start playback event.

```APIDOC
## StartPlay

### Description
Registers a callback function to be executed when the PDF enters playback mode.

### Syntax
`app.Sub.StartPlay = eventHandle`

### Example
```javascript
app.Sub.StartPlay = e => {
  console.log('StartPlay', e);
};
```
```

--------------------------------

### Get Bookmark Start Position

Source: https://solution.wps.cn/docs/client/api/Word/Bookmarks

Retrieves the starting character position of the specified bookmark.

```javascript
//@file=base.docx
async function example() {
  await instance.ready();

  const app = instance.Application;

  // 添加书签
  await app.ActiveDocument.Bookmarks.Add({
    Name: 'WebOffice',
    Range: {
      Start: 1,
      End: 10,
    },
  });

  // 书签内容起始位置
  const start = await app.ActiveDocument.Bookmarks.Item('WebOffice').Start;
  console.log(start); // 1
}
```

--------------------------------

### StartPlay(type, DisFullscreen, HiddenMenu)

Source: https://solution.wps.cn/docs/client/api/PDF/ActivePDF.html

Configures and starts the PDF playback mode.

```APIDOC
## StartPlay(type, DisFullscreen, HiddenMenu)

### Description
Sets the playback mode for the PDF document.

### Syntax
`app.ActivePDF.StartPlay(type, DisFullscreen, HiddenMenu)`

### Parameters
- **type** (String) - Optional - The playback mode (default: 'active').
- **DisFullscreen** (Boolean) - Optional - Whether to enable full-screen mode (default: false).
- **HiddenMenu** (Boolean) - Optional - Whether to hide the menu (default: false).
```

--------------------------------

### Item(Name).Start

Source: https://solution.wps.cn/docs/client/api/Word/Bookmarks

Retrieves the starting position of the specified bookmark.

```APIDOC
## Item(Name).Start

### Description
Returns the starting position of the bookmark content.

### Syntax
`app.ActiveDocument.Bookmarks.Item(Name).Start`
```

--------------------------------

### CoreReadonly

Source: https://solution.wps.cn/docs/client/api/PPT/SlideShowView

Sets or gets whether the presentation is in preview mode.

```APIDOC
## Property: CoreReadonly

### Description
Determines whether the presentation enters preview mode.

### Syntax
`表达式.ActivePresentation.SlideShowWindow.View.CoreReadonly`

### Example
```javascript
async function example() {
  await instance.ready();
  const app = instance.Application;
  const SlideShowWindow = await app.ActivePresentation.SlideShowWindow;
  const view = await SlideShowWindow.View;
  view.CoreReadonly = true;
}
```
```

--------------------------------

### Range.Start

Source: https://solution.wps.cn/docs/client/api/Word/Range

Retrieves the starting character position of the specified range.

```APIDOC
## Range.Start

### Description
Returns the starting position of the range object.

### Syntax
`表达式.ActiveDocument.Range(Start, End).Start`
`表达式.ActiveDocument.Tables.Item(Index).Rows.Item(Index).Cells.Item(Index).Range.Start`
```

--------------------------------

### API Response Examples

Source: https://solution.wps.cn/docs/convert/to-txt.html

JSON response structures for task initiation and status polling.

```json
{
  "code": 0,
  "data": {
    "task_id": "open:zjsiwfuotpbqblrlfwtkfkioargjbla"
  },
  "result": "ok"
}
```

```json
{
  "code": 0,
  "data": {
    "status": "success",
    "progress": 100,
    "result": {
      "txts": [
        {
          "url": "https://***.com/***",
          "size": 70154
        },
        {
          "url": "https://***.com/***",
          "size": 112172
        },
        {
          "url": "https://***.com/***",
          "size": 954
        },
        {
          "url": "https://***.com/***",
          "size": 35327
        }
      ],
      "task":{"elapsed":7892,"resource_size":1070216}
    }
  }
}
```

--------------------------------

### Sections.Item(Index).PageSetup

Source: https://solution.wps.cn/docs/client/api/Word/Sections

Accesses the page setup properties for a specific section.

```APIDOC
## Sections.Item(Index).PageSetup

### Description
Retrieves the `PageSetup` object for the specified section.

### Syntax
`表达式.ActiveDocument.Sections.Item(Index).PageSetup`
```

--------------------------------

### DefaultSorting

Source: https://solution.wps.cn/docs/client/api/Word/Bookmarks

Gets or sets the default sorting order for bookmarks.

```APIDOC
## DefaultSorting

### Description
Gets or sets the sorting order for bookmarks using the WdBookmarkSortBy enumeration.

### Syntax
`表达式.ActiveDocument.Bookmarks.DefaultSorting = WdBookmarkSortBy`

### Example
```javascript
// Get sorting
const sort = await app.ActiveDocument.Bookmarks.DefaultSorting;

// Set sorting
app.ActiveDocument.Bookmarks.DefaultSorting = 0;
```
```

--------------------------------

### Initialize SDK with compatibility handling

Source: https://solution.wps.cn/docs/web/quick-start

A complete example demonstrating SDK initialization within a Babel-transpiled script block for legacy browser support.

```html
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta
      name="viewport"
      content="width=device-width,initial-scale=1.0,maximum-scale=1.0,user-scalable=no"
    />
    <meta http-equiv="X-UA-Compatible" content="ie=edge" />
    <title>兼容低版本浏览器</title>
  </head>

  <body>
    <!-- 引用 babel -->
    <script src="https://cdn.staticfile.org/babel-core/5.8.35/browser.min.js"></script>
    <script src="https://cdn.staticfile.org/babel-core/5.8.35/browser-polyfill.min.js"></script>

    <!-- 引用 JSSDK -->
    <script src="sdk地址"></script>

    <!-- 注意添加 text/babel，否则无法编译 -->
    <script type="text/babel">
      window.onload = function () {
        const jssdk = WebOfficeSDK.init({
          officeType: WebOfficeSDK.OfficeType.Writer,
          appId: 'xxxxx',
          fileId: 'xxxxx'
        })
        const test = async () => {
          await jssdk.ready()
          console.log('api ready')
        }
        jssdk.on('fileOpen', function (data) {
          test()
          console.log('打开成功')
        })
      }
    </script>
  </body>
</html>
```

--------------------------------

### ready()

Source: https://solution.wps.cn/docs/web/instance.html

Initializes and loads the Application object.

```APIDOC
## ready()

### Description
Loads the Application object. Must be called and awaited before performing further API operations.

### Usage
```javascript
await instance.ready()
```
```

--------------------------------

### Get Range Start Position

Source: https://solution.wps.cn/docs/client/api/Word/Range

Retrieves the starting character position of a specified range or a table cell range.

```javascript
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取选中区域
  const range = await app.ActiveDocument.Range(0, 100)

  // 获取选中文本的起点位置
  const start = await range.Start
  console.log(start)
}
```

```javascript
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取第 1 个表格
  const tableOne = await app.ActiveDocument.Tables.Item(1)

  // 获取表格第 1 行的第 1 个单元格
  const cellOne = await tableOne.Rows.Item(1).Cells.Item(1)

  // 获取该单元格的区域对象
  const range = await cellOne.Range

  // 获取开始位置
  const start = await range.Start
  console.log(start)
}
```

--------------------------------

### Initialize WebOffice SDK

Source: https://solution.wps.cn/docs/web/quick-start

Initialize the WebOffice instance using the WebOfficeSDK.init function after the script has loaded.

```html
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>WebOffice</title>
  </head>
  <script src="./web-office-sdk-solution.umd.js"></script>
  <body>
    <script>
      window.onload = () => {
        const instance = WebOfficeSDK.init({
          officeType: WebOfficeSDK.OfficeType.Writer,
          appId: 'xxxxx',
          fileId: 'xxxxx'
        })
      }
    </script>
  </body>
</html>
```

--------------------------------

### Get Individual Slide

Source: https://solution.wps.cn/docs/client/api/PPT/Slides

Retrieves a specific slide object by its index, starting from 1.

```javascript
//@file=base.pptx
async function example() {
  await instance.ready()

  const app = instance.Application
  // 获取幻灯片单个对象
  await app.ActivePresentation.Slides.Item(1)
}
```

--------------------------------

### GetPageWidth JavaScript Example

Source: https://solution.wps.cn/docs/client/api/PDF/ActivePDF.html

Retrieves the width of a specific PDF page by its index, starting from 1.

```javascript
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取指定页码页面的宽度,索引从1开始
  const pageWidth = await app.ActivePDF.GetPageWidth(1)
  console.log(pageWidth)
}
```

--------------------------------

### Run()

Source: https://solution.wps.cn/docs/client/api/PPT/SlideShowSettings

Switches the presentation to full-screen playback mode.

```APIDOC
## Run()

### Description
Switches the presentation to full-screen playback mode.

### Syntax
`表达式.ActivePresentation.SlideShowSettings.Run()`

### Example
```javascript
await app.ActivePresentation.SlideShowSettings.Run();
```
```

--------------------------------

### GetPageHeight JavaScript Example

Source: https://solution.wps.cn/docs/client/api/PDF/ActivePDF.html

Retrieves the height of a specific PDF page by its index, starting from 1.

```javascript
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取指定页码页面的高度,索引从1开始
  const pageHeight = await app.ActivePDF.GetPageHeight(1)
  console.log(pageHeight)
}
```

--------------------------------

### API Response Example

Source: https://solution.wps.cn/docs/convert/img-to-docs.html

The expected JSON response format containing the task ID.

```json
{
    "code": 0,
    "data": {
        "task_id": "0f27ff302780428e9ddfd39189731891"
    }
}
```

--------------------------------

### WebOfficeSDK.init (PDF Options)

Source: https://solution.wps.cn/docs/web/config.html

Initializes the WebOfficeSDK with specific PDF viewing configurations such as comment visibility, safe mode, and status bar display.

```APIDOC
## WebOfficeSDK.init (PDF)

### Description
Initializes the WebOfficeSDK for PDF documents with custom display and interaction settings.

### Parameters
- **pdfOptions** (object) - Optional - Configuration object for PDF behavior:
  - **isShowComment** (boolean) - Optional - Whether to show annotations.
  - **isInSafeMode** (boolean) - Optional - Whether to enable safe mode (disables selection, copy, and links).
  - **isBestScale** (boolean) - Optional - Whether to open with best fit scale.
  - **isShowBottomStatusBar** (boolean) - Optional - Whether to show the bottom status bar.
  - **disBackScrollPos** (boolean) - Optional - Whether to disable scroll position restoration.

### Example
```javascript
WebOfficeSDK.init({
  officeType: WebOfficeSDK.OfficeType.Presentation,
  appId: 'xxxxx',
  fileId: 'xxxxx',
  pdfOptions: {
    isShowComment: false,
    isInSafeMode: false,
    isBestScale: false,
    isShowBottomStatusBar: false,
    disBackScrollPos: true
  }
})
```
```

--------------------------------

### SetRange({ Start, End })

Source: https://solution.wps.cn/docs/client/api/Word/Range

Sets the starting and ending character positions for an existing range.

```APIDOC
## SetRange({ Start, End })

### Description
Sets the starting and ending character positions for an existing range.

### Parameters
- **Start** (Number) - Required - The new starting position.
- **End** (Number) - Required - The new ending position.
```

--------------------------------

### Range.Range(Start, End)

Source: https://solution.wps.cn/docs/client/api/Word/Range

Creates a Range object representing a continuous area in the document defined by start and end character positions.

```APIDOC
## Range(Start, End)

### Description
Returns a Range object representing a continuous area in the document defined by the specified start and end character positions.

### Syntax
`表达式.ActiveDocument.Range(Start, End)`

### Parameters
- **Start** (Number) - Required - The starting character position.
- **End** (Number) - Required - The ending character position.
```

--------------------------------

### WebOfficeSDK.init (Intelligent Document Options)

Source: https://solution.wps.cn/docs/web/config.html

Initializes the WebOfficeSDK for Intelligent Documents (Otl) with specific editor and view feature configurations.

```APIDOC
## WebOfficeSDK.init (Intelligent Document)

### Description
Initializes the WebOfficeSDK for Intelligent Documents. Use `otlOptions` to define which editing features and view components are enabled.

### Parameters
- **otlOptions** (object) - Optional - Configuration object:
  - **loadOptions** (string) - Optional - A JSON string containing the `workbench` configuration:
    - **editor** (array) - List of enabled editing features (e.g., 'title', 'heading', 'bold', 'picture', 'table').
    - **view** (array) - List of enabled view components (e.g., 'startTab', 'mobileMenu', 'contextMenu').

### Example
```javascript
const loadOptions = {
  workbench: {
    editor: ['title', 'heading', 'bold', 'picture', 'table'],
    view: ['startTab', 'mobileMenu', 'contextMenu']
  }
}
WebOfficeSDK.init({
  officeType: WebOfficeSDK.OfficeType.Otl,
  appId: 'xxxxx',
  fileId: 'xxxxx',
  otlOptions: {
    loadOptions: JSON.stringify(loadOptions)
  }
})
```
```

--------------------------------

### With Method

Source: https://solution.wps.cn/docs/client/api/Public/commandbars.html

Allows for batch setting of properties for a custom command bar element.

```APIDOC
## With

### Description
Batch sets properties for a custom element. Refer to individual property documentation for specific usage.

### Syntax
`expression.CommandBars(CommandBarId).Controls.Add(Type).With(Properties)`

### Parameters
- **Caption** (String) - Required - The title of the element.
- **Enabled** (Boolean) - Optional - Whether the element is enabled.
- **Picture** (String) - Optional - The icon for the element.
- **Visible** (Boolean) - Optional - Whether the element is visible.
- **TooltipText** (String) - Optional - The tooltip text for the element.

### Example
```javascript
controlButton.With({
  Caption: '按钮',
  Enabled: false
});
```
```

--------------------------------

### Get and Set Text in Range

Source: https://solution.wps.cn/docs/client/api/Word/Range

Retrieve or modify the text content within a document range or table cell. Requires JSSDK v1.1.10+ for getting and v1.1.11+ for setting text.

```javascript
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取选中区域
  const range = await app.ActiveDocument.Range(0, 100)

  // 获取选中文本
  const text = await range.Text
  console.log(text)

  // 设置文本
  range.Text = 'WebOffice'
}
```

```javascript
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取第 1 个表格
  const tableOne = await app.ActiveDocument.Tables.Item(1)

  // 获取表格第 1 行的第 1 个单元格
  const cellOne = await tableOne.Rows.Item(1).Cells.Item(1)

  // 获取该单元格的区域对象
  const range = await cellOne.Range

  // 获取文本
  const text = await range.Text
  console.log(text)

  // 设置文本
  range.Text = 'WebOffice'
}
```

--------------------------------

### GET /v3/3rd/files/:file_id/watermark

Source: https://solution.wps.cn/docs/callback/extend

获取文档的水印配置信息。

```APIDOC
## GET /v3/3rd/files/:file_id/watermark

### Description
文档水印功能需要实现该接口。

### Method
GET

### Endpoint
/v3/3rd/files/:file_id/watermark

### Parameters
#### Path Parameters
- **file_id** (string) - Required - 文档 Id

### Response
#### Success Response (200)
- **type** (integer) - 水印类型
- **value** (string) - 水印文字内容
- **fill_style** (string) - 水印透明度
- **font** (string) - 水印字体
- **rotate** (float) - 水印旋转度
- **horizontal** (integer) - 水平间距
- **vertical** (integer) - 垂直间距

#### Response Example
{
  "code": 0,
  "message": "",
  "data": {
    "fill_style": "rgba( 192, 192, 192, 0.6 )",
    "font": "bold 20px Serif",
    "horizontal": 50,
    "rotate": -0.7853982,
    "type": 1,
    "value": "谢绝拷贝\n2022-12-07 13:18:11",
    "vertical": 100
  }
}
```

--------------------------------

### 监听 fileOpen 事件

Source: https://solution.wps.cn/docs/web/events.html

监听文档打开状态，需在 instance.ready() 前注册。

```javascript
instance.ApiEvent.AddApiEventListener('fileOpen', data => {
  console.log('fileOpen: ', data)
})
```

```javascript
{
  duration: 812,
  fileInfo: {
    createTime: 1606461829,
    id: "94749723688",
    modifyTime: 1606461829,
    name: "userName",
    officeType: "s",
  },
  stageTime: 1614,
  success: true,
  time: 1614,
  ts: 1607858260164,
}
```

```javascript
{
  msg: "Fail",
  result: "Fail"
}
```

--------------------------------

### WebOfficeSDK.init()

Source: https://solution.wps.cn/docs/web/quick-start

Initializes the WebOffice document instance within the specified container.

```APIDOC
## WebOfficeSDK.init(options)

### Description
Initializes the WebOffice document instance. This function returns an instance that handles the document rendering and interaction within the specified DOM element.

### Parameters
- **appId** (string) - Required - The application ID obtained from the WebOffice console.
- **officeType** (string) - Required - The type of file (e.g., WebOfficeSDK.OfficeType.Writer, Spreadsheet, Presentation, Pdf, Otl, Dbt).
- **fileId** (string) - Required - The unique identifier for the file.
- **mount** (HTMLElement|string) - Optional - The DOM element or selector where the document iframe will be mounted. Defaults to '#app'.
- **token** (string|object) - Optional - Token for business system authentication, passed via X-WebOffice-Token header in callbacks.
- **refreshToken** (Function) - Optional - A function returning a Promise to refresh the token.
- **endpoint** (string) - Optional - The service endpoint URL.
- **customArgs** (object) - Optional - Custom parameters passed to the WebOffice service, accessible via X-User-Query in callbacks.
- **attrAllow** (string|string[]) - Optional - Configuration for the iframe 'allow' attribute.
- **isListenResize** (boolean) - Optional - Whether to automatically resize the container on browser resize events. Defaults to true.

### Request Example
```javascript
const instance = WebOfficeSDK.init({
  officeType: WebOfficeSDK.OfficeType.Writer,
  appId: 'xxxxx',
  fileId: 'xxxxx'
});
```
```

--------------------------------

### GET /v3/3rd/files/:file_id/versions

Source: https://solution.wps.cn/docs/callback/extend

获取文档的历史版本列表，支持分页查询。

```APIDOC
## GET /v3/3rd/files/:file_id/versions

### Description
WebOffice 侧支持查看历史版本列表，该功能需要实现该接口。

### Method
GET

### Endpoint
/v3/3rd/files/:file_id/versions

### Parameters
#### Path Parameters
- **file_id** (string) - Required - 文档 ID

#### Query Parameters
- **offset** (integer) - Optional - 列表偏移量
- **limit** (integer) - Optional - 单页最大长度

### Response
#### Success Response (200)
- **id** (string) - 文档 ID
- **name** (string) - 文档名称
- **version** (integer) - 文档版本号
- **size** (integer) - 文档大小
- **create_time** (integer) - 创建时间
- **modify_time** (integer) - 修改时间
- **creator_id** (string) - 创建者 ID
- **modifier_id** (string) - 最后修改者 ID

#### Response Example
{
  "code": 0,
  "data": [
    {
      "create_time": 1670218748,
      "creator_id": "404",
      "id": "27",
      "modifier_id": "404",
      "modify_time": 1670314818,
      "name": "样张.xlsx",
      "size": 14820,
      "version": 2
    }
  ],
  "message": ""
}
```

--------------------------------

### 初始化隐藏组件

Source: https://solution.wps.cn/docs/web/config.html

在 WebOfficeSDK 初始化时通过 commandBars 数组配置组件的 visible 和 enable 属性。

```javascript
WebOfficeSDK.init({
  officeType: WebOfficeSDK.OfficeType.Writer,
  appId: 'xxxxx',
  fileId: 'xxxxx',
  commandBars: [
    {
      cmbId: 'HeaderLeft', // 组件 ID
      attributes: {
        visible: false, // 隐藏组件
        enable: false // 禁用组件，组件显示但不响应点击事件
      }
    }
  ]
})
```

--------------------------------

### RowHeight

Source: https://solution.wps.cn/docs/client/api/Excel/Range

Gets or sets the height of the range.

```APIDOC
## RowHeight

### Description
Gets or sets the height of the range.

### Syntax
`range.RowHeight`
```

--------------------------------

### Play(slideIndex, animateIndex)

Source: https://solution.wps.cn/docs/client/api/PPT/SlideShowView

Starts the slideshow playback from a specific slide and animation index.

```APIDOC
## Play(slideIndex, animateIndex)

### Description
Starts the slideshow playback from the specified slide and animation index.

### Parameters
- **slideIndex** (Number) - Required - The index of the current slide.
- **animateIndex** (Number) - Required - The index of the current animation on the slide.
```

--------------------------------

### StartAutoPlay()

Source: https://solution.wps.cn/docs/client/api/PPT/SlideShowSettings

Enables automatic playback mode for the presentation slideshow. This method is only supported on PC.

```APIDOC
## StartAutoPlay()

### Description
Enables automatic playback mode for the presentation slideshow.

### Syntax
`表达式.ActivePresentation.SlideShowSettings.StartAutoPlay()`

### Example
```javascript
await SlideShowSettings.StartAutoPlay();
```
```

--------------------------------

### GET /v3/3rd/files/:file_id/versions/:version/download

Source: https://solution.wps.cn/docs/callback/extend

获取历史版本文档的下载地址。

```APIDOC
## GET /v3/3rd/files/:file_id/versions/:version/download

### Description
历史版本预览，回滚等相关功能需要获取回滚版本的下载地址。

### Method
GET

### Endpoint
/v3/3rd/files/:file_id/versions/:version/download

### Parameters
#### Path Parameters
- **file_id** (string) - Required - 文档 Id
- **version** (integer) - Required - 文档版本

### Response
#### Success Response (200)
- **url** (string) - 文档下载地址
- **digest** (string) - 文档校验和
- **digest_type** (string) - 文档校验和算法
- **headers** (map) - 额外请求头

#### Response Example
{
  "code": 0,
  "message": "",
  "data": {
    "url": "https://foo.bar.com/files/9/180"
  }
}
```

--------------------------------

### Set and Get Playback Mode

Source: https://solution.wps.cn/docs/client/api/PDF/ActivePDF.html

Configures the playback state for the PDF document.

```javascript
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  const pdf = await app.ActivePDF

  // 设置播放状态
  pdf.PlayMode = 'start'

  // 获取播放状态
  const mode = await pdf.PlayMode
  console.log(mode)
}
```

--------------------------------

### GET /v3/3rd/files/:file_id/versions/:version

Source: https://solution.wps.cn/docs/callback/extend

获取文档指定历史版本的详细信息。

```APIDOC
## GET /v3/3rd/files/:file_id/versions/:version

### Description
历史版本预览，回滚等相关功能需要获取回滚的版本信息。

### Method
GET

### Endpoint
/v3/3rd/files/:file_id/versions/:version

### Parameters
#### Path Parameters
- **file_id** (string) - Required - 文档 ID
- **version** (integer) - Required - 文档版本

### Response
#### Success Response (200)
- **id** (string) - 文档 ID
- **name** (string) - 文档名称
- **version** (integer) - 文档版本号
- **size** (integer) - 文档大小
- **create_time** (integer) - 创建时间
- **modify_time** (integer) - 修改时间
- **creator_id** (string) - 创建者 ID
- **modifier_id** (string) - 最后修改者 ID

#### Response Example
{
  "code": 0,
  "message": "",
  "data": {
    "create_time": 1670218748,
    "creator_id": "404",
    "id": "xxxxxxxxx",
    "modifier_id": "404",
    "modify_time": 1670328304,
    "name": "统计月报.xlsx",
    "size": 18961,
    "version": 180
  }
}
```

--------------------------------

### Initialize JSSDK with Display Mode

Source: https://solution.wps.cn/docs/web/config.html

Configures the display mode during initialization. Use 'simple' to hide the header and toolbar.

```javascript
const jssdk = WebOfficeSDK.init({
  officeType: WebOfficeSDK.OfficeType.Writer,
  appId: 'xxxxx',
  fileId: 'xxxxx',
  mode: 'simple'
})
```

--------------------------------

### Initialize WebOffice SDK

Source: https://solution.wps.cn/docs/client/api/summary.html

Wait for the ready state of the WebOffice instance before invoking any API methods.

```javascript
window.onload = async function () {
  const instance = WebOfficeSDK.init({
    // 必填项
    officeType: WebOfficeSDK.OfficeType.Spreadsheet,
    appId: 'xxxxx',
    fileId: 'xxxxx'
  })

  // 需要等待实例 ready 之后再调用 API
  await instance.ready()
}
```

--------------------------------

### Font.Size

Source: https://solution.wps.cn/docs/client/api/Excel/Font.html

Gets or sets the font size.

```APIDOC
## Font.Size

### Description
Gets or sets the font size.

### Syntax
`expression.Range.Font.Size`

### Example
```javascript
font.Size = 30;
const size = await font.Size;
```
```

--------------------------------

### Font.Color

Source: https://solution.wps.cn/docs/client/api/Excel/Font.html

Gets or sets the color of the font.

```APIDOC
## Font.Color

### Description
Gets or sets the font color.

### Syntax
`expression.Range.Font.Color`

### Example
```javascript
const color = await font.Color;
font.Color = '#eb5451';
```
```

--------------------------------

### HTTP Request Example

Source: https://solution.wps.cn/docs/convert/overview.html

A sample POST request for document conversion, demonstrating the required headers and body structure.

```http
POST /api/v1/openapi/office/convert/to/pdf
Content-Md5: d41d8cd98f00b204e9800998ecf8427e
Content-Type: application/json
DATE: Wed, 23 Jan 2013 06:43:08 GMT
Authorization: WPS-2:******:ac59dac1460772a04b3a97d7ef78409f28241e3a

{
    "url": "https://***.com/***",
    "filename": "文字文稿.docx"
}***.com/*** 
```

--------------------------------

### Shape.Height

Source: https://solution.wps.cn/docs/client/api/Word/Shapes

Gets or sets the height of a shape object.

```APIDOC
## Shape.Height

### Description
Accesses or modifies the height of a specific shape object.

### Syntax
`表达式.ActiveDocument.Shapes.Item(Index).Height`
```

--------------------------------

### WebOfficeSDK.init() Configuration

Source: https://solution.wps.cn/docs/web/config.html

The WebOfficeSDK.init() function accepts a configuration object to customize the behavior of the WebOffice components. Beyond the required appId, officeType, and fileId, developers can provide settings for collaboration, UI components, and specific document types like Word, PPT, PDF, and Smart Documents.

```APIDOC
## WebOfficeSDK.init(config)

### Description
Initializes the WebOffice instance with specific configuration options for UI, collaboration, and component-specific behaviors.

### Parameters
- **config** (Object) - Required - Configuration object containing:
  - **mode** (string) - Display mode.
  - **cooperUserAttribute** (Object) - Collaboration user configuration.
  - **onToast** (Function) - Custom toast handler.
  - **onHyperLinkOpen** (Function) - Intercepts hyperlink navigation.
  - **commandBars** (Array) - Initial state configuration for command bars.
  - **commonOptions** (Object) - General component options (e.g., isShowTopArea, isShowHeader).
  - **wordOptions** (Object) - Word-specific options (e.g., isShowDocMap, isBestScale).
  - **pptOptions** (Object) - PPT-specific options (e.g., isShowRemarkView, isShowInsertMedia).
  - **pdfOptions** (Object) - PDF-specific options (e.g., isInSafeMode, isShowComment).
  - **otlOptions** (Object) - Smart document-specific options.
```

--------------------------------

### Set Spreadsheet Zoom Level

Source: https://solution.wps.cn/docs/client/api/summary.html

Example of initializing the SDK and setting the zoom level of the active window.

```html
<script src="./web-office-sdk.umd.js"></script>
<script>
  window.onload = async function () {
    const instance = WebOfficeSDK.init({
      // 必填项
      officeType: WebOfficeSDK.OfficeType.Spreadsheet,
      appId: 'xxxxx',
      fileId: 'xxxxx'
    })

    // 等待加载完毕
    await instance.ready()

    // 自动识别
    const app = instance.Application

    // 操作窗口缩放比例
    app.ActiveWindow.Zoom = 10
  }
</script>
```

--------------------------------

### Shape.Width

Source: https://solution.wps.cn/docs/client/api/Word/Shapes

Gets or sets the width of a shape object.

```APIDOC
## Shape.Width

### Description
Accesses or modifies the width of a specific shape object.

### Syntax
`表达式.ActiveDocument.Shapes.Item(Index).Width`
```

--------------------------------

### Range.ColumnWidth

Source: https://solution.wps.cn/docs/client/api/Excel/Range

Gets or sets the width of the columns in the range.

```APIDOC
## Range.ColumnWidth

### Description
Gets or sets the width of the columns in the range.

### Syntax
`expression.Range.ColumnWidth`
```

--------------------------------

### Start PDF Playback

Source: https://solution.wps.cn/docs/client/api/PDF/ActivePDF.html

Initiates the PDF playback mode with configurable fullscreen and menu visibility settings.

```javascript
//@file=base.pdf
async function example() {
  await instance.ready()

  const app = instance.Application

  await app.ActivePDF.StartPlay('active', true, true)
}
```

--------------------------------

### Navigate to Document Field Start

Source: https://solution.wps.cn/docs/client/api/Word/DocumentFields

Moves the cursor to the beginning of a specified document field. Requires the document to be ready before execution.

```javascript
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 插入公文域
  await app.ActiveDocument.DocumentFields.Add({
    Name: '1',
    Range: { Start: 12, End: 20 },
    Hidden: false, // 是否隐藏，默认 false
    PrintOut: true, // 是否可打印，默认 true
    ReadOnly: true // 是否只读，默认 false
  })

  // 公文域集合的单个公文域
  const documentField = await app.ActiveDocument.DocumentFields.Item({
    Name: '1'
  })

  // 跳转到公文域的开始位置
  await documentField.GotoBegin()
}
```

--------------------------------

### CharacterUnitFirstLineIndent

Source: https://solution.wps.cn/docs/client/api/Word/ParagraphFormat

Gets or sets the first-line indentation for the paragraph.

```APIDOC
## CharacterUnitFirstLineIndent

### Description
Sets or retrieves the first-line indentation value for the specified paragraph range.

### Syntax
`expression.ActiveDocument.Range(Start, End).ParagraphFormat.CharacterUnitFirstLineIndent`

### Example
```javascript
const paragraphFormat = await app.ActiveDocument.Range(0, 20).ParagraphFormat;
paragraphFormat.CharacterUnitFirstLineIndent = 2;
```
```

--------------------------------

### Zoom

Source: https://solution.wps.cn/docs/client/api/Excel/Window

Gets or sets the zoom percentage of the window.

```APIDOC
## Zoom

### Description
Gets or sets the zoom percentage of the window.

### Return Value
`Number` (zoom percentage)

### Example
```javascript
const zoom = await app.ActiveWindow.Zoom
app.ActiveWindow.Zoom = 10
```
```

--------------------------------

### Enter Fullscreen Presentation Mode

Source: https://solution.wps.cn/docs/client/api/PPT/SlideShowSettings

Switches the presentation to full-screen playback mode using the Run method.

```javascript
//@file=base.pptx
async function example() {
  await instance.ready()

  const app = instance.Application

  // Slide 设置对象
  const SlideShowSettings = await app.ActivePresentation.SlideShowSettings

  // 进入幻灯片播放模式
  await SlideShowSettings.Run()
}
```

--------------------------------

### Font.Underline

Source: https://solution.wps.cn/docs/client/api/Excel/Font.html

Gets or sets the underline style for the font.

```APIDOC
## Font.Underline

### Description
Gets or sets the font underline style. Supported values are defined in Enum.XlUnderlineStyle.

### Syntax
`expression.Range.Font.Underline`

### Example
```javascript
const underline = await font.Underline;
font.Underline = app.Enum.XlUnderlineStyle.xlUnderlineStyleSingle;
```
```

--------------------------------

### SetRange Method Examples

Source: https://solution.wps.cn/docs/client/api/Word/Selection

Demonstrates modifying range boundaries using positional arguments or an object configuration.

```javascript
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取选中区域
  const range = await app.ActiveDocument.Range(0, 10)

  // 设置区域范围
  await range.SetRange(10, 20)
}
```

```javascript
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取第 1 个表格
  const tableOne = await app.ActiveDocument.Tables.Item(1)

  // 获取表格第 1 行的第 1 个单元格
  const cellOne = await tableOne.Rows.Item(1).Cells.Item(1)

  // 获取该单元格的区域对象
  const range = await cellOne.Range

  // 单元格字体属性
  const font = await range.Font

  // 修改区域范围
  const newRange = await range.SetRange({
    Start: 1,
    End: 10
  })
  const newText = await newRange.Text // 获取新区域文本
  console.log(newText)
}
```

--------------------------------

### Font.Strikethrough

Source: https://solution.wps.cn/docs/client/api/Excel/Font.html

Gets or sets the strikethrough formatting for the font.

```APIDOC
## Font.Strikethrough

### Description
Gets or sets whether the font has a strikethrough.

### Syntax
`expression.Range.Font.Strikethrough`

### Example
```javascript
const strikethrough = await font.Strikethrough;
font.Strikethrough = true;
```
```

--------------------------------

### Font.Italic

Source: https://solution.wps.cn/docs/client/api/Excel/Font.html

Gets or sets the italic formatting for the font.

```APIDOC
## Font.Italic

### Description
Gets or sets whether the font is italic.

### Syntax
`expression.Range.Font.Italic`

### Example
```javascript
const italic = await font.Italic;
font.Italic = true;
```
```

--------------------------------

### CommandBars(CommandBarId).Controls.Add(10).Controls.Add()

Source: https://solution.wps.cn/docs/client/api/Public/commandbars.html

在指定的 CommandBar 中添加一个下拉框，并向该下拉框内部添加新的定制元素。

```APIDOC
## CommandBars(CommandBarId).Controls.Add(10).Controls.Add()

### Description
在指定的工具栏中创建一个下拉框控件，并向该下拉框内部添加子控件。

### 语法
`表达式.CommandBars(CommandBarId).Controls.Add(10).Controls.Add()`

### 示例
```javascript
// 添加 1 个定制元素：下拉框
const control = await controls.Add(10);
control.Caption = '下拉框';

// 获取下拉框
const popupControls = await control.Controls;

// 新增下拉框内定制元素
const button = await popupControls.Add(1);
button.Caption = '下拉按钮 1';
```
```

--------------------------------

### Font.Bold

Source: https://solution.wps.cn/docs/client/api/Excel/Font.html

Gets or sets the bold formatting for the font.

```APIDOC
## Font.Bold

### Description
Gets or sets whether the font is bold.

### Syntax
`expression.Range.Font.Bold`

### Example
```javascript
const isBold = await font.Bold;
font.Bold = true;
```
```

--------------------------------

### 监听 previewLimit 事件

Source: https://solution.wps.cn/docs/web/events.html

监听预览页数限制，仅支持 Word、PPT 和 PDF 组件。

```javascript
instance.ApiEvent.AddApiEventListener('previewLimit', data => {
  console.log('previewLimit: ', data)
})
```

```javascript
// 文字
// 由于文字文档是流式排版，无法获取准确的真实页数，因此回调只有 total 一个参数
{
  total: 4 // 限制页数
}
// PPT 以及 PDF
{
  total: 4 // 限制页数
  realTotal: 10 // 真实总页数
}
```

--------------------------------

### Initialize PDF Options

Source: https://solution.wps.cn/docs/web/config.html

Configures PDF-specific settings such as comment visibility, safe mode, and status bar display during SDK initialization.

```javascript
WebOfficeSDK.init({
  officeType: WebOfficeSDK.OfficeType.Presentation,
  appId: 'xxxxx',
  fileId: 'xxxxx',
  pdfOptions: {
    isShowComment: false, // 是否显示注解，默认显示
    isInSafeMode: false, // 是否处于安全模式（安全模式下不能划选文字，不能复制以及不能通过链接跳转），默认不是安全模式
    isBestScale: false, // 默认以最佳显示比例打开
    isShowBottomStatusBar: false, // 是否展示底部状态栏
    disBackScrollPos: true // 是否禁用滚动还原
  }
})
```

--------------------------------

### ChartTitle

Source: https://solution.wps.cn/docs/client/api/Excel/Chart.html

Property to set or get the chart title.

```APIDOC
## ChartTitle

### Description
Sets or retrieves the title of the chart.

### Syntax
`表达式.ActiveWorkbook.ActiveSheet.Shapes.Item(Index).Chart.ChartTitle`
```
Tokens:
Raw