ONLYOFFICE Docs 8.0 per sviluppatori: aggiornamenti API e Doc Builder

Insieme al rilascio delle nuove funzionalità nella versione 8.0, abbiamo aggiornato l’API per gli editor, il Document Builder e i plugin. Scopri tutti i dettagli qui sotto.

Supporto PDF

Abbiamo aggiunto il tipo di documento pdf al parametro documentType. Ciò significa che i file PDF*, compresi quelli contenenti campi compilabili, adesso sono completamente supportati e possono essere aperti per aggiungere annotazioni e per essere compilati in ONLYOFFICE PDF Editor (prima questi file venivano riconosciuti come documenti e aperti nell’editor di documenti).

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

*Anche DjVu, OXPS e XPS

API per lavorare con i moduli

Il parametro formsdataurl aggiunto al gestore di Callback consente di definire l’URL del file JSON con i dati del modulo inviato. Questo file contiene i seguenti parametri:

• chiave
• tag
• valore
• tipo (text, checkBox, picture, comboBox, dropDownList, dateTime, radio)

Inoltre, troverai nuovi metodi di modulo nell’API di DocBuilder:

• ApiDocument/GetFormsData che restituisce i dati di tutti i moduli presenti nel documento presente;
• ApiDocument/SetFormsData che imposta i dati nei moduli specificati.

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();

Supporto WOPI migliorato

L’ultima versione porta anche il parametro di query WOPISrc che viene aggiunto alle richieste dal browser al server. Ciò consente di creare diverse istanze indipendenti di ONLYOFFICE. Le richieste di bilanciamento del carico con WOPISrc assicurano che la modifica collaborativa funzioni correttamente: tutti gli utenti che modificano lo stesso documento sono serviti dallo stesso server.

Per WOPI viene utilizzato il parametro inviato dall’integratore. Per l’API Docs, il parametro document.key si scrive in WOPISrc.

API di conversione

Il campo filigrana aggiunto alla richiesta di conversione definisce un oggetto JSON contenente le proprietà di una filigrana che viene inserita nel PDF e nei file di immagine durante la conversione.

"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 ],
  ...

Supporto per database Oracle e Microsoft SQL Server

Tra i database supportati ora ci sono anche Oracle e Microsoft SQL Server. Per connetterli, cambia il tipo di database in oracle / mssql. Per Docker sarò necessario regolare il parametero DB_TYPE.

Inoltre puoi usare:

• Impostazioni avanzate per oracle – oracleExtraOptions
• Impostazioni avanzate per mssql – msSqlExtraOptions

Avatar degli utenti

A partire dalla versione 8.0, è possibile aggiungere un avatar utente che verrà mostrato negli editor per una migliore visualizzazione del team.

Pertanto, l’operazione info è aggiunta al metodo setUsers e all’evento onRequestUsers per impostare gli avatar per gli utenti con gli ID specificati nel parametro data.id. E il nuovo campo users.image definisce il percorso dell’avatar dell’utente.

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"             
     },

Inoltre, il parametro editorConfig.user adesso contiene il campo immagine per definire il percorso dell’avatar dell’utente:

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

Altri aggiornamenti dell’API per gli editor

• Il parametro editorConfig.customization.mobileForceView per definire se l’editor di documenti mobile viene aperto in modalità visualizza/modifica all’avvio. Il valore predefinito è true.
• Il campo link nell’oggetto dati che viene inviato all’evento events.onRequestReferenceData.

Ottieni l’ultima versione di ONLYOFFICE Docs Developer:

SCARICALA ORA

Miglioramenti dell’API per i plugin

I metodi dei plugin appena aggiunti consentono di avviare e gestire le presentazioni:

• EndSlideShow
• GoToNextSlideInSlideShow
• GoToPreviousSlideInSlideShow
• GoToSlideInSlideShow
• PauseSlideShow
• ResumeSlideShow
• StartSlideShow

Di seguito sono riportati alcuni esempi di codice:

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

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

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

Ulteriori aggiornamenti dell’API per Document Builder

Nell’API DocBuilder, abbiamo anche aggiunto diversi riquadri di blocco, metodi di commento e altri ancora, inclusi i seguenti:

• ApiFreezePanes/GetLocation che restituisce un intervallo che descrive le celle bloccate nella visualizzazione attiva del foglio di lavoro.
• ApiBlockLvlSdt/AddComment che aggiunge un commento al controllo del contenuto del blocco corrente.
• ApiSection/GetPageHeight che ottiente l’altezza della sezione seguente.
• ApiDocument/AddDrawingToPage che aggiunge una forma alla pagina specificata.

Consulta la lista completa di nuovi metodi.

SCARICA BUILDER