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

23 octubre 2023Por Sergey

Junto con el lanzamiento de las nuevas características de la versión 7.5, hemos actualizado la API para los editores, el Document Builder, los plugins y la aplicación de escritorio. Descubre todos los detalles a continuación.

API para trabajar con formularios

Ocultar/mostrar el botón Enviar formulario. Utilizando el parámetro editorConfig.customization.submitForm es posible definir si el botón Enviar se muestra u oculta en la barra de herramientas superior para los archivos OFORM.

var docEditor = new DocsAPI.DocEditor("placeholder", {     
"editorConfig": {         
"customization": {
...
"submitForm": true,

Parámetro adicional para la opción Forzar Guardar. En la versión 7.5, añadimos el tipo 3 para el parámetro forcesavetype del controlador de devolución de llamada. Si se aplica, la solicitud de Forzar Guardar se realiza cada vez que se envía el formulario, por ejemplo, cuando se pulsa el botón Enviar.

{    
 "changesurl": "https://documentserver/url-to-changes.zip",     
"forcesavetype": 3,
....

API para trabajar con documentos

Cambiar el origen de los datos externos. El nuevo evento events.onRequestReferenceSource es llamado cuando un usuario intenta cambiar una fuente de datos externos pulsando el botón Cambiar fuente en los editores. En el parámetro data se envía un objeto con los datos únicos del archivo y la ruta o nombre del archivo.

Cuando se pulsa el botón, se debe llamar al método setReferenceSource para cambiar el origen de los datos externos. Al llamar a este método, se debe añadir el token para validar los parámetros. Si no se declara el evento, no se mostrará el botón Cambiar origen.

var onRequestReferenceSource = function () 
{     var referenceData =  event.data.referenceData;     
var path = event.data.path; 
...
    docEditor.setReferenceSource({        
"fileType": "xlsx",         
"path": "sample.xlsx",         
"referenceData": {             
"fileKey": "BCFA2CED",             
"instanceId": "https://example.com",             
"key": "Khirz6zTPdfd7"        
},

Campo clave. El campo clave añadido al parámetro document.referenceData define el identificador único del documento utilizado por el servicio para tomar los datos de la sesión de coedición.

En caso de que se envíe la clave conocida, el documento se tomará de la caché. Cada vez que se edite y guarde el documento, la clave deberá generarse de nuevo.

La URL del documento puede utilizarse como clave, pero sin caracteres especiales y con una longitud limitada a 128 símbolos.

var docEditor = new DocsAPI.DocEditor("placeholder", {     
"document": {         
"fileType": "docx",         
"key": "Khirz6zTPdfd7",         
"referenceData": {             
"fileKey": "BCFA2CED",             
"instanceId": "https://example.com",             
"key": "Khirz6zTPdfd7"        
},

API de conversión

La API de conversión se amplía con el código de error -9 que se produce cuando el convertidor no puede determinar automáticamente el formato del archivo de salida.

Este error significa que el cliente debe especificar explícitamente en qué formato debe convertirse el archivo: documento de texto u hoja de cálculo. Se utiliza para convertir XML a OOXML en caso de que se desconozca el tipo de XML.

{     
"error": -9 
}

Otras actualizaciones

el evento events.onRequestOpen utilizado para mostrar el botón Abrir origen.
los comandos deleteForgotten, getForgotten y getForgottenList para trabajar con archivos olvidados.
el evento events.onRequestSelectSpreadsheet en lugar del obsoleto events.onRequestMailMergeRecipients.
el método setRequestedSpreadsheet en lugar del obsoleto setMailMergeRecipients.
el evento events.onRequestSelectDocument en lugar del obsoleto events.onRequestCompareFile.
el método setRequestedDocument en lugar del obsoleto setRevisedFile.

Además, en la API de la aplicación de escritorio, hemos añadido el parámetro uiTheme al comando portal:login que define la configuración del tema del editor al conectar los editores de escritorio a la nube.

Consigue la última versión de ONLYOFFICE Docs Developer Edition:

DESCARGAR AHORA

Mejora de la API para plugins

El nuevo parámetro align del método ShowButtonindica si el botón se mostrará a la derecha o a la izquierda de la ventana. El valor por defecto es “izquierda”.

window.Asc.plugin.executeMethod ("ShowButton", ["back", false, "right"]);

Actualizaciones de la API del Document Builder

En la API del DocBuilder, hemos añadido varios métodos nuevos de control de contenido de marcas de agua y cuadros combinados y listas desplegables, así como varios métodos globales y de diapositivas, entre los que se incluyen los siguientes:

Consulta la lista completa de los nuevos métodos.

DESCARGAR BUILDER