ONLYOFFICE文档API：编辑器的品牌定制化

article/2025/8/25 21:08:55

在当今数字化办公时代，文档编辑器已成为各类企业、组织和开发者不可或缺的工具之一。ONLYOFFICE 文档提供的功能丰富且强大的文档编辑 API，让开发者能够根据自己的产品需求和品牌特点，定制编辑器界面，实现品牌化展示，为用户提供了一个深度契合其品牌形象和业务需求的文档操作体验。下面一起来了解ONLYOFFICE文档API，帮助实现编辑器定制化。

关于 ONLYOFFICE 文档

ONLYOFFICE 是一个开源项目，专注于高级和安全的文档处理和协作。全球超过 1500 万用户，是在线办公领域的创新者。

ONLYOFFICE 文档提供文本文档、电子表格、幻灯片、表单和 PDF 编辑器。ONLYOFFICE 文档高度兼容微软 Office 格式，并提供数百种格式化和样式工具，以及多种协作功能，包括实时和段落锁定两种共同编辑模式、评论和审阅、内置聊天、版本历史等。

​

该办公套件可以连接到多个云平台，如 WordPress、Seafile、Moodle等，也可以集成到您自有的应用程序、网站或其他解决方案，为其提供强大的编辑功能，还提供个性化的定制功能来满足产品的品牌化需求。

ONLYOFFICE 可以在任何平台上部署，包括 Windows、Linux、macOS、Android，也可以在任何设备上使用。在线、移动和桌面版本均使用同一引擎，确保离线和在线工作之间无缝切换。

下面我们一起了解关于编辑器自定义的API。

什么是品牌自定义

品牌自定义是指根据企业自身的品牌形象和风格，对相关界面或元素进行个性化设置的功能。在自定义部分，您可以对编辑器界面进行调整，使其与其他产品（如果有）在视觉风格上保持一致，实现品牌整体形象的统一。同时，您还可以灵活设置是否显示附加按钮和链接，更换徽标，以及修改编辑器所有者信息等细节内容，以此来打造符合品牌特色的专属编辑环境，提升品牌辨识度和用户体验。ONLYOFFICE 开发者版当前可支持标准品牌定制和白标定制，满足不同程度的定制化需求。

标准品牌定制

编辑器开发者版本可以根据您的需求进行标准品牌定制，包括：定制编辑器的行为和外观。

  • 隐藏功能提示

editorConfig.customization.features.featuresTips 参数允许在更新后首次加载编辑器时启用或禁用有关新功能的工具提示。默认值为 true。

  • 显示电子表格滚动条

从 8.3 版本开始，可以定义在加载电子表格编辑器时是否自动显示或隐藏水平/垂直滚动条。查看 editorConfig.customization.showHorizontalScroll 和 editorConfig.customization.showVerticalScroll 来控制这些参数。默认值为 true.

  • 演示文稿幻灯片背景

使用 editorConfig.customization.slidePlayerBackground 参数以 HEX、RGB 或 RGBA 格式定义幻灯片背景颜色。例如，#ff0000、rgb(255, 0, 0)、rgba(255, 0, 0, 0.5)。

showHorizontalScroll: true,
showVerticalScroll: true,
slidePlayerBackground: "#000000",

  • 文档标题颜色

使用 editorConfig.customization.wordHeadingsColor 参数自定义文档编辑器中默认标题颜色，并允许使用HEX 颜色规范（十六进制颜色）。

  • 紧凑文档标题

你可以选择附加操作按钮的位置，在编辑器窗口标题的上部靠近徽标 (false) ，或是显示在工具栏 (true)，使标题更紧凑。默认值为 false。

  •  查看器的紧凑工具栏

editorConfig.customization.compactToolbar 参数现在支持查看器模式，允许在完整工具栏和紧凑工具栏之间切换。查看模式的默认值为 true。

  • 移动编辑器中的信息按钮

使用 editorConfig.customization.mobile.info 决定显示或隐藏移动编辑器中“文档信息”。默认值为 false。

  • 指针模式

使用 editorConfig.customization.pointerMode 参数调整演示文稿查看器中的指针模式（选择或手形）。默认值为 select。

API 汇总：ONLYOFFICE 文档最新更新

  • 自定义展示信息

您可以自定义编辑器关于部分中显示的信息，包括文档授权者的联系地址、公司信息、公司logo、电子邮箱、公司名称和联系电话、网址等。这部分信息对所有编辑器用户可见。

const customer = {address: "My City, 123a-45",info: "Some additional information",logo: "https://example.com/logo-big.png",logoDark: "https://example.com/dark-logo-big.png",mail: "john@example.com",name: "John Smith and Co.",phone: "123456789",www: "example.com",
}
自定义地址

editorConfig.customization.customer.address 参数授予编辑者或编辑者作者访问权限的公司或个人的联系地址。
示例: My City, 123a-45

自定义信息

关于您希望其他人知道的公司或个人的一些附加信息。

示例: Some additional information

自定义logo

editorConfig.customization.customer.logo 参数支持设置图像徽标，图片 logo 推荐透明背景的 .png 格式，尺寸为432x70。editorConfig.customization.customer.logoDark支持深色主题图像徽标

示例1: https://example.com/logo-big.png

示例2: https://example.com/dark-logo-big.png

自定义电子邮箱​

使用editorConfig.customization.customer.mail授予编辑者或编辑者作者访问权限的公司或个人的电子邮件地址。

示例: john@example.com

自定义名称​

​使用editorConfig.customization.customer.name授予编辑者或编辑者作者访问权限的公司或个人的名称。

示例: John Smith and Co.

自定义联系方式​

使用editorConfig.customization.customer.phone授予编辑器或编辑器作者访问权限的公司或个人的电话。

示例: 123456789

自定义网址​

使用editorConfig.customization.customer.www添加上述公司或个人的主页地址。

示例: example.com

自定义信息的展示示例如下：

  • 自定义品牌logo

更改编辑器标题左上角的图像文件。推荐的图像高度为 20 像素。

请注意， 此参数仅适用于 ONLYOFFICE 文档开发者版的编辑，以及移动编辑器。

示例：

const logo = {image: "https://example.com/logo.png",imageDark: "https://example.com/dark-logo.png",imageLight: "https://example.com/light-logo.png",url: "https://example.com",visible: true,
}

logo图标

customization-standard-branding/#logoimage使用editorConfig.customization.logo.image在通用工作模式（即所有编辑器的查看和编辑模式）或嵌入模式（请参阅配置部分以了解如何定义嵌入文档类型）中显示的图像文件的路径。图片必须具有以下尺寸：172x40.

示例: https://example.com/logo.png

logo.深色图标​

使用editorConfig.customization.logo.imageDark在深色标题的图像文件的路径（例如，在深色主题中或带有彩色标题的主题中）。图像必须具有以下尺寸：172x40。

示例: https://example.com/dark-logo.png

logo.浅色图标​

使用editorConfig.customization.logo.imageLight在浅色标题的图像文件的路径（例如，在灰色主题中）。图像必须具有以下尺寸：172x40。

示例: https://example.com/light-logo.png

ONLYOFFICE 文档 API 提供了全面且细致的品牌化定制选项，涵盖了从界面元素的显示与隐藏、布局调整到品牌信息的深度融入等各个方面。无论是企业内部系统集成、独立软件产品开发，还是 SaaS 平台的文档服务模块定制，都能轻松应对。

立即定制您的编辑器界面

想要将 ONLYOFFICE 文档编辑器集成到您的产品中吗？请访问我们的官方网站，下载最新版本的 ONLYOFFICE 文档开发者版。点击下方链接，申请免费试用30天：

下载 ONLYOFFICE 服务器解决方案，并以您的品牌提供给您的客户 | ONLYOFFICEhttps://www.onlyoffice.com/zh/download-developer.aspx?utm_source=csdn&utm_medium=article&utm_campaign=doc_api_roundup

相关链接

ONLYOFFICE 文档开发者版

API 文档

自动化 API

ONLYOFFICE 文档 8.3


http://www.hkcw.cn/article/MTLXjdEJkZ.shtml

相关文章

【unity游戏开发——编辑器扩展】EditorApplication公共类处理编辑器生命周期事件、播放模式控制以及各种编辑器状态查询

【unity游戏开发——编辑器扩展】EditorApplication公共类处理编辑器生命周期事件、播放模式控制以及各种编辑器状态查询

注意：考虑到编辑器扩展的内容比较多，我将编辑器扩展的内容分开，并全部整合放在【unity游戏开发——编辑器扩展】专栏里，感兴趣的小伙伴可以前往逐一查看学习。 文章目录 前言一、监听编辑器事件1、常用编辑器事件2、示例监听播放模…
阅读更多...
企业如何制定互联网营销策略？

企业如何制定互联网营销策略？

互联网环境的变化速度，让很多企业不懂得在这个流量时代该如何更好地抓住推广时机。企业在制定互联网营销策略的过程中，该如何让策略能够成功生效，令其为企业发展赋能呢？下面就让我们分四步来简单了解下。 一、明确品牌定位 在制定…
阅读更多...
Windows10下搭建sftp服务器（附：详细搭建过程、CMD连接测试、连接失败问题分析解决等）

Windows10下搭建sftp服务器（附：详细搭建过程、CMD连接测试、连接失败问题分析解决等）

最终连接sftp效果 搭建sftp服务器 1、这里附上作者已找好的 freeSSHd安装包 ，使用它进行搭建sftp服务器。 2、打开freeSSHd安装包，进行安装 (1)、选择完全安装 (2)、安装完成后，对提示窗口选择关闭 (3)、安装完成后，提示是否安装私有密钥。我们选择"是" (4)、安…
阅读更多...
第五十九节：性能优化-GPU加速 (CUDA 模块)

第五十九节：性能优化-GPU加速 (CUDA 模块)

在计算机视觉领域，实时性往往是关键瓶颈。当传统CPU处理高分辨率视频流或复杂算法时，力不从心。本文将深入探索OpenCV的CUDA模块，揭示如何通过GPU并行计算实现数量级的性能飞跃。 一、GPU加速：计算机视觉的必由之路 CPU的强项在于复杂逻辑和低延迟任务，但面对图像处理中高…
阅读更多...
Linux---系统守护systemd（System Daemon)

Linux---系统守护systemd（System Daemon)

一、systemd 概述 1. 定位与作用 init 系统替代品：作为 Linux 系统的第 1 个进程（PID1），替代传统的 SysVinit 和 Upstart，负责管理系统服务、启动流程、资源分配等。统一管理：通过 单元（Unit&…
阅读更多...
Lua语言学习

Lua语言学习

为什么要用Lua 大部分的手机系统出于安全考虑禁止从网络上下载代码后动态的将这些下载的代码加载到内存中执行 所以，当你更新游戏时，就必须让用户从手机市场下载更新版本的程序，游戏程序通常体积较大，重新下载不仅耗时还耗流量&…
阅读更多...
Maven 仓库类型与镜像策略

Maven 仓库类型与镜像策略

🧑 博主简介：CSDN博客专家，历代文学网（PC端可以访问：https://literature.sinhy.com/#/?__c1000，移动端可微信小程序搜索“历代文学”）总架构师，15年工作经验，精通Java编…
阅读更多...
蓝牙和wifi相关的杂项内容总结

蓝牙和wifi相关的杂项内容总结

蓝牙的传输速率演进 蓝牙技术的传输速率随着版本的演进不断提升，不同版本和模式（经典蓝牙 BR/EDR 和低功耗蓝牙 BLE）的速率差异显著。以下是蓝牙传输速率的完整发展历程和技术细节： 经典蓝牙（BR/EDR）的速…
阅读更多...
AAA稳态LED太阳光模拟器的特点剖析

AAA稳态LED太阳光模拟器的特点剖析

AAA稳态LED太阳光模拟器作为光伏测试领域的重要设备，其技术特点直接关系到太阳能电池研发与质量控制的精度。以下从光谱匹配性、辐照均匀性、稳定性、能效比及智能化设计五个维度展开深度剖析： 一、光谱匹配性的突破性进展 传统氙灯光源在AM1.5G标准光谱…
阅读更多...
cadence PCB 精度设置成小数点4位方法

cadence PCB 精度设置成小数点4位方法

1. allegro 在进行PCB设计时，单位一般默认为Mils，会遇到，精度只能选择2位，不能增加到4位， 精度的范围只能设置为0-2，不能设置为3或4 2. Setup -> User preference，进行设置&#xff0c…
阅读更多...
VirtualBox安装 Rocky

VirtualBox安装 Rocky

这不是 CentOS要完蛋了吗，找了Rock Linux 。下载了一个差不多需要10G，艹。 然后在virtual BOX中安装，安装成功了 安装和Centos一样： 《VirtualBox安装以及安装CentOS7》 有几点需要注意就行了： 准备工作 确保主机的…
阅读更多...
【MySQL】C语言连接

【MySQL】C语言连接

要使用C语言连接mysql，需要使用mysql官网提供的库，大家可以去官网下载 我们使用C接口库来进行连接 要正确使用，我们需要做一些准备工作: 保证mysql服务有效在官网上下载合适自己平台的mysql connect库，以备后用 下载开发库 s…
阅读更多...
SpringBoot 日志

SpringBoot 日志

今天我们来学习日志，日志是啥玩意呢，其实我们之前使用过超简易版的日志，就是打印，我感觉大家应该都一样，使用打印来检查代码是不是执行到这里了，通过控制台打印的日志来发现问题，排查问题&#…
阅读更多...
C语言——深入理解指针（1）

C语言——深入理解指针（1）

一、内存和地址 1.1 内存 在讲内存之前，我们先看一个生活中的案例： 假设有一栋宿舍楼，把你放在楼里，楼上有100个房间，但是房间没有编号，你的一个朋友来找你玩，如果想找到你，就得挨…
阅读更多...
计算机操作系统（十四）互斥锁，信号量机制与整型信号量

计算机操作系统（十四）互斥锁，信号量机制与整型信号量

计算机操作系统（十四）互斥锁，信号量机制与整型信号量 前言一、进程互斥与互斥锁1. 什么是进程互斥？2. 互斥锁是什么？ 二、信号量机制（解决互斥的更通用方案）1. 为什么需要信号量？2. …
阅读更多...
铸铁平台的优势和应用

铸铁平台的优势和应用

铸铁平台是一种具有广泛应用的工业设备，其在各个领域均发挥着重要作用。本文将探讨铸铁平台的优势和应用，以帮助读者更好地了解这一重要设备。 一、铸铁平台的优势 强度高：铸铁平台采用高强度铸铁材料制成，具有优异的强度和耐磨性…
阅读更多...
EfficMultiCoreMemoryPool项目

EfficMultiCoreMemoryPool项目

目录 1. 定长内存池介绍 2. tcmalloc整体框架了解 2.1 ThreadCache设计 各区间内存浪费分析 2.1.1 ThreadCache申请内存 2.1.2 ThreadCache释放内存 2.1.3 TLS线程局部变量 2.2 CentralCache设计 2.2.1 CentralCache申请内存 ThreadCache --> CentralCache的申请内…
阅读更多...
【Doris基础】Apache Doris vs 传统数据仓库：架构与性能的全面对比

【Doris基础】Apache Doris vs 传统数据仓库：架构与性能的全面对比

目录 1 引言 1.1 传统数据仓库的发展 1.2 现代分析型数据库的崛起 2 核心架构对比 2.1 传统数据仓库的架构 2.2 Doris的架构设计 3 关键技术差异 3.1 存储引擎对比 3.2 查询执行对比 3.3 数据摄入方式对比 4 性能与扩展性对比 4.1 性能基准对比 4.2 扩展性对比 5…
阅读更多...
字符串转换函数-leetCode-008

字符串转换函数-leetCode-008

问题描述： 实现一个将字符串转换为整数的函数时，需要考虑各种边界情况和细节，例如空格的处理、符号的判断、数字的读取以及整数溢出的处理等。以下是详细的解题过程以及代码实现。 问题分析 空格处理：需要丢弃字符串开头的空格字…
阅读更多...
深度学习目标检测实战——YOLOv8从入门到部署

深度学习目标检测实战——YOLOv8从入门到部署

本文将手把手带你用 YOLOv8（目前非常先进的目标检测框架）实现从数据标注到模型部署的全流程实战，并达到工业级检测精度！ [yolo视频教程，戳蓝字即可学习] 这才是科研人该学的【YOLO算法全系列】，一口气学完…
阅读更多...
推荐文章

Copyright @ 2022~2023