在当今数字化办公时代,文档编辑器已成为各类企业、组织和开发者不可或缺的工具之一。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支持深色主题图像徽标

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

示例2https://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.pswp.cn/pingmian/83223.shtml
繁体地址,请注明出处:http://hk.pswp.cn/pingmian/83223.shtml
英文地址,请注明出处:http://en.pswp.cn/pingmian/83223.shtml

如若内容造成侵权/违法违规/事实不符,请联系英文站点网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Java开发经验——阿里巴巴编码规范实践解析6

摘要 本文深入解析了阿里巴巴编码规范在数据库设计和Java开发中的实践应用。详细阐述了数据库字段命名、类型选择、索引命名等规范,以及Java POJO类的对应规范。强调了字段命名的重要性,如布尔字段命名规则、表名和字段名的命名禁忌等。同时&#xff0c…

笔试笔记(运维)

(数据库,SQL) limit1 随机返回其中一个聚合函数不可以嵌套使用 【^】这个里面的数据任何形式组合都没有 sql常用语句顺序:from-->where-->group by-->having-->select-->order by-->limit 只要其中一个表存在匹…

Codeforces 1027 Div3(ABCDEF)

前言 无敌!!第一次打Div3,因为之前打Div4赛时也就三四题,所以在打之前根本没想到自己能做到赛时三题!!虽然第三题是离结束十几秒的时候交的,没想到判完题比赛结束了还不算赛时通过……TvT A. …

第九天:java注解

注解 1 什么是注解(Annotation) public class Test01 extends Object{//Override重写的注解Overridepublic String toString() {return "Test01{}";} }2 内置注解 2.1 Override Override重写的注解 Override public String toString() {ret…

【论文解读】Deformable DETR | Deformable Transformers for End-to-End Object Detection

论文地址:https://arxiv.org/pdf/2010.04159 代码地址:https://github.com/fundamentalvision/Deformable-DETR 摘要 DETR最近被提出,旨在消除物体检测中许多手工设计的组件的需求,同时展示出良好的性能。然而,由于T…

从0到1上手Trae:开启AI编程新时代

摘要:字节跳动 2025 年 1 月 19 日发布的 Trae 是一款 AI 原生集成开发环境工具,3 月 3 日国内版推出。它具备 AI 问答、代码自动补全、基于 Agent 编程等功能,能自动化开发任务,实现端到端开发。核心功能包括智能代码生成与补全、…

Vue项目打包常见问题

vue的前端项目中,有时候需要多个不同项目合并到一起。有时候有一些特殊要求。 1、打包后不允许生成带 .map的文件 正常使用npm run build命令打包生成的dist文件中,js文件总会生成一个同名的.map文件,原因如下: ‌总结‌&#xf…

Linux 学习-模拟实现【简易版bash】

1、bash本质 在模拟实现前,先得了解 bash 的本质 bash 也是一个进程,并且是不断运行中的进程 证明:常显示的命令输入提示符就是 bash 不断打印输出的结果 输入指令后,bash 会创建子进程,并进行程序替换 证明&#x…

GitHub 趋势日报 (2025年05月31日)

📊 由 TrendForge 系统生成 | 🌐 https://trendforge.devlive.org/ 🌐 本日报中的项目描述已自动翻译为中文 📈 今日获星趋势图 今日获星趋势图 1153 prompt-eng-interactive-tutorial 509 BillionMail 435 ai-agents-for-begin…

“人单酬“理念:财税行业的自我驱动革命

引言:当薪酬不再是"固定数字",而是"成长标尺" "为什么有人拼命工作却收入停滞?为什么企业总在人才流失中挣扎?"这些问题背后,往往隐藏着传统薪酬体系的僵化。而"人单酬"&…

AI大模型赋能,aPaaS+iPaaS构建新一代数智化应用|爱分析报告

01 aPaaS和iPaaS成为企业用户关注重点 PaaS市场定义 根据Gartner的定义,PaaS(Platform as a Service)平台是应用基础架构(中间件)服务的广泛集合, 包含应用平台、集成、业务流程管理、数据服务和AI应用等…

WPS快速排版

论文包括(按顺序):封面(含题目)、摘 要、关键词、Abstract(英文摘要)、Keywords、目录、正文、参考文献、在读期间发表的学术论文及研究成果,致 谢 题目(黑小一加粗&…

python第39天打卡

1.灰度图像 作为图像数据,相较于结构化数据(表格数据)他的特点在于他每个样本的的形状并不是(特征数,),而是(宽,高,通道数) # 先继续之前的代码 import torch import torch.nn as nn import t…

win11小组件功能缺失的恢复方法

问题说明:重置了win11系统,结果小组件功能找不到了,最后用以下办法解决。 1. 以管理员身份打开 PowerShell 或 CMD。 2. 运行以下命令: winget install 9MSSGKG348SP 注:如果报错,可尝试先卸载再安装…

Kali Linux从入门到实战:系统详解与工具指南

一、Kali Linux简介 Kali Linux是一款基于Debian的Linux发行版,专为渗透测试和网络安全审计设计,由Offensive Security团队维护。其前身是BackTrack,目前集成了超过600款安全工具,覆盖渗透测试全流程,是网络安全领域…

C语言 — 文件

目录 1.流1.1 流的概念1.2 常见的的流 2.文件的打开和关闭2.1 fopen函数2.2 fclose函数2.3 文件的打开和关闭 3.文件的输入输出函数3.1 fputc函数3.2 fgetc函数3.3 feof函数和ferror函数3.4 fputs函数3.5 fgets函数3.6 fwrite函数3.7 fread函数3.8 fprintf函数3.9 fscanf函数 4…

Pull Request Integration 拉取请求集成

今天我想要把我创建的项目,通过修改yaml里面的内容,让我在main分支下的其他分支拉取请求的时候自动化测试拉取的内容,以及将测试结果上传到控制台云端。 首先我通过修改yaml文件里面的内容 name: Build and Teston:push:branches:- mainjobs:…

NodeJS全栈开发面试题讲解——P3数据库(MySQL / MongoDB / Redis)

3.1 如何用 Node.js 连接 MySQL?你用过哪些 ORM? 面试官您好,我先介绍如何用 Node.js 连接 MySQL,然后补充我常用的 ORM 工具。 🔌 原生连接 MySQL 使用 mysql2 模块: npm install mysql2 const mysql …

Redis最佳实践——性能优化技巧之数据结构选择

Redis在电商应用中的数据结构选择与性能优化技巧 一、电商核心场景与数据结构选型矩阵 应用场景推荐数据结构内存占用读写复杂度典型操作商品详情缓存Hash低O(1)HGETALL, HMSET购物车管理Hash中O(1)HINCRBY, HDEL用户会话管理Hash低O(1)HSETEX, HGET商品分类目录Sorted Set高O…

题单:最大公约数(辗转相除法)

题目描述 所谓 “最大公约数(GCD)” ,是指所有公约数中最大的那个,例如 12 和 1818 的公约数有 1,2,3,6 ,所以 12 和 18 的最大公约数为 6 。 辗转相除法,又名欧几里德算法(Euclidean Algorit…