createClassicEditorOfdPlugin · OFD 导出
注册原生 OFD 导出服务,复用当前文档的固定布局内容。需要 OFD 资源与字体策略,不通过 PDF 中转。
注册原生 OFD 导出服务,复用当前文档的固定布局内容。需要 OFD 资源与字体策略,不通过 PDF 中转。
@quirekit/classic-ofd · Commercial
编辑器适用范围
层次:Classic 产品适配
| 编辑器 | 状态 | 所需装配与边界 |
|---|---|---|
| Classic | 直接支持 | 这是 Classic 产品插件,加入 createClassicEditor 的 plugins;依赖的模型、宿主端口和服务必须按下方配置提供。 |
| Block | 未支持 | Block 不消费 Classic 产品 contribution、plugins 或分页装配。请使用共享能力和 Block 适配入口,不能直接复制此入口的 Classic 配置。 |
“直接支持”指已有上述产品装配;具体交互、宿主服务和格式支持仍有各自条件。状态与接入规则。许可独立显示。
接入
当前 @quirekit/classic-ofd 的包元数据标为 private。本站使用工作区源码;外部项目需先取得对应分发包,不能把下面的公开导出理解为已经能从公共 npm 安装。
此入口属于商业组件。使用前先取得相应分发与授权;安装命令仅适用于已配置该分发源的项目。
这是产品层接入:将产品插件放入 createClassicEditor 的 plugins,不要放进 Core 的 extensions。必填宿主端口见下面的配置。
import { createClassicEditorOfdPlugin } from '@quirekit/classic-ofd'
const ofd = createClassicEditorOfdPlugin({ fileName: 'report.ofd' })
安装时按包声明选择兼容版本,外部可用版本以分发源为准。本站使用工作区 Alpha;许可标签来自入口所属包,使用条件见支持与许可。
按编辑器接入
以下片段沿用已挂载的宿主元素 element,宿主负责容器尺寸与保存;退出页面时调用 instance.destroy()。已有预设装配的能力不要再重复追加;需要宿主端口的入口应先完成下方配置。
Classic · 直接支持
这是 Classic 产品插件,加入 createClassicEditor 的 plugins;依赖的模型、宿主端口和服务必须按下方配置提供。
import { createClassicEditor } from '@quirekit/classic-editor'
import '@quirekit/classic-editor/styles.css'
import { createClassicWordDefaultDocument } from '@quirekit/classic-docx'
import { createClassicWordPreset } from '@quirekit/classic-docx'
import '@quirekit/classic-docx/styles.css'
import { createClassicEditorOfdPlugin } from '@quirekit/classic-ofd'
const instance = createClassicEditor({
element,
preset: createClassicWordPreset(),
document: createClassicWordDefaultDocument(),
plugins: [createClassicEditorOfdPlugin()],
})Block · 未支持
Block 不消费 Classic 产品 contribution、plugins 或分页装配。请使用共享能力和 Block 适配入口,不能直接复制此入口的 Classic 配置。
配置
字段传入创建函数的 options。标为“必填”的端口由宿主提供;undefined 表示未显式配置,下面会说明创建层的回退。
pluginId
产品插件的唯一身份,同一实例内不能冲突。
类型:string
默认:"classic.ofd"
serviceId
注册到产品的文件服务身份,菜单按此身份调用服务。
类型:string
默认:"ofd"
fileName
建议导出的文件名,包含对应格式扩展名。
类型:string
默认:"document.ofd"
pageGeometry
显式导出页面几何;未提供时优先读取文档 Word 分节页面设置。
类型:QuirePageGeometry
默认:undefined
textMeasurer
无挂载完整排版使用的文字测量器,应与字体资源匹配。
类型:QuireTextMeasurer
默认:undefined
fonts
明确提供的可嵌入字体资源。安装插件不会自动获得字体文件。
类型:readonly QuireOfdFontSource[]
默认:undefined
fontEmbedding
OFD 字体嵌入策略,选择完整字体或 Unicode 子集。
类型:"full" | "subset"
默认:undefined
loadFonts
导出时按需加载字体;提供此函数时优先于 fonts。
类型:(context: ClassicEditorServiceContext): readonly QuireOfdFontSource[] | Promise<readonly QuireOfdFontSource[]>
默认:undefined
resolveImage
按资产引用读取图片字节的宿主函数。
类型:(command: QuireImageCommand): Promise<QuireOfdResolvedImage | undefined> | QuireOfdResolvedImage | undefined
默认:createClassicEditorOfdImageResolver( context.instance.media.resolver )
metadata
输出文件的标题、作者等文档信息。
类型:QuireOfdMetadata
默认:undefined
fallbackMode
原生导出后端遇到不支持内容时的损失处理策略。
类型:"diagnostic" | "strict"
默认:undefined
onReport
文件操作完成后的结构化报告回调,用于呈现保真度、资源或损失诊断。
类型:(detail: ClassicEditorOfdExportReportDetail): void
默认:undefined
命令与运行方式
此入口没有直接声明可枚举的命令。组合扩展的命令由子扩展提供;产品插件通过 contribution 或文件服务工作。不能把安装入口名称当作命令调用。
下一步
继续Classic 快速接入和配置与生命周期。开发自己的产品界面与服务时,见产品插件开发。