ONLYOFFICE Docs 8.0 para desarrolladores: actualizaciones de la API y Doc Builder

5 febrero 2024By Sergey

Junto con el lanzamiento de las nuevas funciones de la versión 8.0, hemos actualizado la API para los editores, el Document Builder y los plugins. Descubre todos los detalles a continuación.

Сompatibilidad con PDF

Hemos añadido el tipo de documento pdf al parámetro documentType. Esto significa que los archivos PDF*, incluyendo los que contienen campos rellenables, ahora son totalmente compatibles y se pueden abrir para anotar y rellenar en el Editor de PDF de ONLYOFFICE (antes tales archivos se reconocían como documentos y se abrían en el editor de documentos).

var docEditor = new DocsAPI.DocEditor("placeholder", {     
    "documentType": "pdf",

*También DjVu, OXPS y XPS

API para trabajar con formularios

El parámetro formsdataurl añadido al controlador Callback permite definir la URL al archivo JSON con los datos del formulario enviado. Este archivo contiene los siguientes parámetros:

clave
etiqueta
valor
tipo (text, checkBox, picture, comboBox, dropDownList, dateTime, radio)

Además, encontrarás nuevos métodos de formulario en la API de DocBuilder:

ApiDocument/GetFormsData que devuelve los datos de todos los formularios presentes en el documento actual;
ApiDocument/SetFormsData que establece los datos de los formularios especificados.

builder.CreateFile("docx"); 
var oDocument = Api.GetDocument(); 
var oParagraph1 = oDocument.GetElement(0); 
var oCheckBox = Api.CreateCheckBoxForm({"key": "BestCompany"}); 
oParagraph1.Push(oCheckBox); 
var oTextForm = Api.CreateTextForm({"key": "CompanyName"}); 
oParagraph1.Push(oTextForm); 
oDocument.SetFormsData([    
   {"key": "BestCompany", "value": true},     
   {"key": "CompanyName", "value": "ONLYOFFICE"} 
]); 
builder.SaveFile("docx", "SetFormsData.docx"); 
builder.CloseFile();

Mejor compatibilidad con WOPI

La última versión incluye el parámetro de consulta WOPISrc que se añade a las solicitudes del navegador al servidor. Esto te permite crear varias instancias independientes de ONLYOFFICE. Las solicitudes de equilibrio de carga con WOPISrc garantizan que la edición colaborativa funcione correctamente: todos los usuarios que editan el mismo documento acceden al mismo servidor.

Para WOPI, se utiliza el parámetro enviado por el integrador. Para la API de Docs, el parámetro document.key se escribe en WOPISrc.

API de conversión

El campo de marca de agua añadido a la solicitud de conversión define un objeto JSON que contiene las propiedades de una marca de agua que se inserta en los archivos PDF y de imagen durante la conversión.

"async": false,    
"filetype": "docx",     
"key": "Khirz6zTPdfd7",     
"outputtype": "pdf",     
"title": "Example Document Title.docx",     
"url": "https://example.com/url-to-example-document.docx",     
"watermark": {         
  "align": 1,         
  "fill": [255, 0, 0],        
  "height": 100,        
  "margins": [ 10, 10, 10, 10 ],
  ...

Compatibilidad con bases de datos Oracle y Microsoft SQL Server

Entre las bases de datos soportadas se encuentran ahora también Oracle y Microsoft SQL Server. Para conectarlas, cambia el tipo de base de datos a oracle / mssql. Para Docker, tendrás que ajustar el parámetro DB_TYPE.

Además, puedes utilizar:

Configuración avanzada de conexión para oracle – oracleExtraOptions
Configuración avanzada de conexión para mssql – msSqlExtraOptions

Avatares de usuario

A partir de la versión 8.0 es posible añadir avatares de usuarios que se mostrarán en los editores para una mejor visualización del equipo.

Así, se añade el tipo de operación info al método setUsers y al evento onRequestUsers para establecer los avatares de los usuarios con los ID especificados en el parámetro data.id. Y el nuevo campo users.image define la ruta al avatar del usuario.

var onRequestUsers = function (event) {     
   var c = event.data.c;     
   var id = event.data.id;    
   ...      
docEditor.setUsers({         
   "c": event.data.c,         
   "users": [             
     {                 
     "email": "john@example.com",                 
     "id": "78e1e841",                 
     "image": "https://example.com/url-to-user-avatar1.png",                 
     "name": "John Smith"             
     },

Además, el parámetro editorConfig.user contiene ahora el campo de imagen para definir la ruta al avatar del usuario:

var docEditor = new DocsAPI.DocEditor("placeholder", {    
"editorConfig": {
...
    "user": {             
    "group": "Group1",             
    "id": "78e1e841",             
    "image": "https://example.com/url-to-user-avatar.png",             
    "name": "John Smith"         
     }

Más actualizaciones de la API para los editores

El parámetro editorConfig.customization.mobileForceView para definir si el editor de documentos móvil se abre en el modo de vista/edición en el lanzamiento. El valor predeterminado es true.
El campo de enlace en el objeto de datos que se envía al evento events.onRequestReferenceData.

Obtén la última versión de ONLYOFFICE Docs Developer:

DESCARGAR AHORA

API enhancements for plugins

API enhancements for plugins:

A continuación encontrarás varios ejemplos de código:

window.Asc.plugin.executeMethod ("StartSlideShow");

window.Asc.plugin.executeMethod ("GoToSlideInSlideShow", [2]);

window.Asc.plugin.executeMethod ("EndSlideShow");

Nuevas actualizaciones de la API del Document Builder

En la API de DocBuilder, también hemos añadido múltiples paneles de congelación y métodos de comentario, además de algunos otros, entre los que se incluyen los siguientes:

ApiFreezePanes/GetLocation que devuelve un rango que describe las celdas congeladas en la vista de hoja de cálculo activa.
ApiBlockLvlSdt/AddComment que añade un comentario al control de contenido del bloque actual.
ApiSection/GetPageHeight que obtiene la altura de página de la sección actual.
ApiDocument/AddDrawingToPage que añade una forma a la página especificada.

Consulta la lista completa de nuevos métodos.

DESCARGAR BUILDER