@docx-editor.dev/editor-api (英语)
通过 Office.js 对象模型中支持的子集来编辑 DOCX 文件. API包括段落,范围,评论和修订. 使用 load() 队列读取和 sync() 以解剖法应用每批.
在服务器上运行 API 覆盖 DOCX 字节,或在浏览器中针对打开的编辑器. 见 Office.js 兼容性 关于受支助成员和与办事处的差别.
npm install @docx-editor.dev/editor-api @docx-editor.dev/core
服务器使用需要节点.js ^20.16.0 || >=22.3.0。 。 。 .
按任务分列的指南
开始 运行时间和设置 财务报告和审定财务报表 夹击、装入和出错。 。 。 .
| 任务 | 指南 |
|---|---|
| 读取、插入、替换或删除文本 | 文字和范围 |
将段落拆分为 insertText() 财务报告和审定财务报表 \n,也作为跟踪变化 | 拆分段落 |
| 查找匹配或使用书签 | 搜索和导航 |
| 设置字体、段落属性、样式或链接 | 格式和样式 |
| 创建和配置列表 | 清单和编号 |
| 工作表值、行、列和单元格 | 表格和单元格 |
| 插入并调整图像大小 | 内嵌图片 |
| 插入字段, 写入其缓存结果, 或计算 PAGE 和 NUMPGES | 字段和页形 |
| 从 OOXML 插入等式 | 插入等式 |
| 提出分块、字段或等式作为跟踪变化 | 跟踪更改 |
| 提出模型中的段落重写为最少的跟踪更改 | 提议重写AI,与 prepareRewrite 从 @docx-editor.dev/editor-api/agent |
| 设置页面几何和编辑页眉、页脚或注释 | 页面布局和故事 |
| 填充模板控制并编辑其元数据 | 内容控制 |
| 讨论内容和管理线索 | 评论 |
| 创建、检查、接受或拒绝跟踪更改 | 跟踪更改 |
| 查找任何公共对象、方法、属性或支持类型 | API 成员目录 |
在服务器上
根项打开 DOCX 字节,编辑文档,并返回所保存的字节.
import { readFile, writeFile } from 'node:fs/promises';
import { DocxEditor } from '@docx-editor.dev/editor-api';
const runtime = await DocxEditor.createServer(await readFile('contract.docx'), {
author: 'Review bot',
});
try {
const filled = await runtime.run(async (context) => {
const matches = context.document.body.search('{{cap}}', { matchCase: true });
matches.load('items');
await context.sync(); // Read the matching ranges.
for (const match of matches.items) match.insertText('$500k', 'Replace');
await context.sync(); // Commit all writes in one atomic batch.
return matches.items.length;
});
console.log(`replaced ${filled}`);
await writeFile('contract.filled.docx', await runtime.save());
} finally {
runtime.dispose();
}
createServer 在解析前解析文档,而不保留输入缓冲。 然后可以重新使用或转移缓冲器。 每个 save() 返回独立的 Uint8Array。将保存的字节装入活编辑器,以显示服务器编辑.
在服务器上创建跟踪更改
开始于 Office.js 开发者指南 用于完整的服务器实例和分批公约.
设定 document.changeTrackingMode = 'TrackMineOnly',然后使用标准 Office.js 编辑方法。 供应代理商 author 打开服务器或合作运行时间时:
await runtime.run(async (context) => {
const matches = context.document.body.search('within 7 days');
matches.load('items');
await context.sync();
if (matches.items.length !== 1) throw new Error('Choose a unique target');
context.document.changeTrackingMode = 'TrackMineOnly';
const replacement = matches.items[0]!.insertText('within 30 days', 'Replace');
await context.sync();
replacement.load('text');
await context.sync();
});
使用 range.insertText(text, 'Before' | 'After') 用于插入,以及 range.delete() 或者说 range.clear() 用于删除. insertText() 返回插入范围。 模式任务和编辑 sync(); 失败的批次保留了上一个模式和文档。 装入 document.changeTrackingMode 在读之前. Off 是初始模式.
这是一个支持的 Office.js 子集 . TrackMineOnly 应用到此服务器主机并坚持到整个服务器主机 run() 打电话 它不会改变同行的跟踪设置,也不会保存全文件的跟踪策略. TrackAll 失败 NotSupported. 浏览器跟踪的写作需要Pro审查模块;运行时间设置不会改变编辑器UI模式. 被跟踪的文本编辑支持一个段落,包括表格单元格文本,以及相邻的兄妹段落外部协作. 跟踪 Paragraph.delete() 财务报告和审定财务报表 Range.delete() 整个段落的记录删除了案文并删除了段落标记,这也是在合作中。 字体、段落格式、段落样式和 readingOrder 更改记录属性修改,插入段落的记录插入文字和段落标记。 被跟踪的编辑可以进入另一个作者待处理的文本插入或删除的内部或相邻处,每个作者的修改保留单独的决定. 运行时间会拒绝触摸自己待修改的编辑,另一个作者的段落标记,格式化,移动,或结构变化,并在行内有待插入或删除的文本. 跟踪段落分割通过 insertText() 与 \n字段通过 insertField() 取得结果 Field.result,一次一个方程 insertOoxml() 制作本土修改。 其他结构变化在跟踪时拒绝. 完整名单见 订正15. 评论和修订决定仍然有效。 设定 Off 明确用于永久编辑.
见 服务器代理审查示例 为霍库斯波克斯, stale-read 处理,和审查生命周期.
在浏览器中
将打开的核心、 React 或 Vue 编辑器传递到 createBrowser()。编辑使用编辑器的撤消历史。 通过自有编辑器保存.
import { DocxEditor } from '@docx-editor.dev/editor-api/browser';
const runtime = DocxEditor.createBrowser(editor, { author: 'Demo Reviewer' });
try {
await runtime.run(async (context) => {
const heading = context.document.body.paragraphs.getFirstOrNullObject();
heading.load('text');
await context.sync();
if (!heading.isNullObject) heading.font.bold = true;
await context.sync();
});
} finally {
runtime.dispose();
}
使用 /browser 打开编辑器的条目。 使用服务器上的根条目将浏览器渲染代码从捆绑中排除出.
供应 author 供评论、答复和跟踪编辑。 浏览器评论也要求Pro审查模块和一个可编辑的文件. 处理错误 code。见 评论 财务报告和审定财务报表 跟踪更改 用于支助行动.
方案拟订模式
- 在读取属性前装入属性 。 装入收藏
items在项目属性之前. - 批次独立写作方式
sync()。失败的批次没有应用写;早期的成功同步仍然被承诺 . - 在使用返回对象之前插入后同步 .
- 内置代理
runtime.run(),或明确跟踪和采用它们. - 编辑段落后再次搜索 。 现有幅度保留原有的抵销额.
- 检查
isNullObject在使用无对象存取器时同步. - 在使用前检查无效字体值和审查日期 .
见 夹击、装入和出错 用于交易限制、代理寿命和错误恢复.
Office.js 兼容性
API 执行 Office.js 对象模型的一个已记录子集。 它运行时没有Office.js主机,不需要Office.js包. 见 Office.js 兼容性 用于支持操作、运行时间差异和兼容性报告.
服务器页面域更新需要配置有字体资源的测量器. 见 字段和页形 和可运行的报告代理.
要从前审查者, Bridge, MCP, 或聊天API 升级, 请参见 移徙。 。 。 .
软件包
| 软件包 | 说明 |
|---|---|
@docx-editor.dev/react | 反应适配器. <DocxEditor>提供原始物 钩子和复合铬. |
@docx-editor.dev/core | 框架-可知性引擎:OOXML读取/写出,犬形文档树,布局,颜料. |
@docx-editor.dev/i18n | 共享区域字符串和类型 . |
@docx-editor.dev/pro | 跟踪更改、注释和自定义节点. |
@docx-editor.dev/editor-api | 支持 Office.js 子集用于在服务器或打开编辑器中编辑文档 . |
哪些 API 任务
使用 React 或 Vue 适配器钩, 复检钩,以及 DocxEditorReview 从 @docx-editor.dev/pro/react 或者说 @docx-editor.dev/pro/vue 用于构建浏览器审查控制。 使用编辑 API 在 @docx-editor.dev/editor-api 用于文档自动化。 它遵循Office.js对象模型,在浏览器和服务器主机中运行.
| 任务 | 浏览器控制( React 或 Vue) | 文件自动化 |
|---|---|---|
| 对已找到文本的评论 | editor.findMatches, (中文(简体) ), editor.selectMatch,则 useReview().comment | body.search,则 Range.insertComment |
| 对线索的答复 | useReview().reply(item, text) | Comment.reply(text) |
| 记录跟踪替换 | 那么建议模式 editor.exec({ type: 'replaceMatch', match, text }) | document.changeTrackingMode = 'TrackMineOnly',则 Range.insertText(text, 'Replace') |
| 提议将AI重写为已跟踪的更改 | prepareRewrite 结束 DocxEditor.createBrowser | prepareRewrite 从 @docx-editor.dev/editor-api/agent |
| 接受或拒绝更改 | useReview().accept(item) 或者说 useReview().reject(item) | Revision.accept() 或者说 Revision.reject() |
| 不滚动打开更改 | useReview().setActive(key, { reveal: false }) | 不适用:无取景口 |
| 突出显示区域 | useHighlights(name, source, options) | 不适用 |
| 自定义审查铁路卡 | DocxEditorReview 与 preset 设置为 false, (中文(简体) ), useReviewCardHeights, (中文(简体) ), useStackedReviewPositions,以及 useReviewRailMetrics | 不适用 |
| 关于选择的注释按钮 | DocxEditorReview.AddComment 作为直系儿童 DocxEditorReview,或 useEditorCommand('review.addComment') | 不适用 |
| 页面设置和段落对话框 | DocxEditor.PageSetupDialog 或者说 DocxEditor.ParagraphDialog | Section.pageSetup,以及 Paragraph 属性,例如 alignment |
这个包装了任务秘方 docs/index.md.这些网站还有: 任务配方。 。 。 .
许可证
此软件包使用 EigenPal Pro 许可证。见 定价 许可证和支持选项.
捐款
欢迎捐款。 见 捐款额 用于设置,测试,以及一次性CLA签名.
商业支助
[!TIP]问题或定制特征? 电子邮件 docx-编辑器@eigenpal.com。 。 。 .