Šta je novo u ONLYOFFICE API 9.4: Vodič za programere o najnovijim ažuriranjima

Verzija 9.4 ONLYOFFICE donosi velika poboljšanja API-ju za integracije, prilagođene dodatke i automatizaciju tabela. Ovaj članak ističe ključna ažuriranja u ONLYOFFICE Docs API-ju, Plugins i Macros API-ju, i Office JavaScript API-ju, i objašnjava šta to znači za programere.

ONLYOFFICE Docs API 9.4

Podrška za hrvatski jezik

Hrvatski (hr) je dodat na listu podržanih jezika interfejsa. Ako razvijate lokalizovane aplikacije za korisnike koji govore hrvatski, možete ga uključiti u svoju jezičku konfiguraciju bez zaobilaženja.

Podaci o ulozi i korisniku u događaju onStartFilling

onStartFilling događaj sada uključuje roles parametar koji nosi informacije o ulozi i korisniku. To znatno olakšava izgradnju iskustava popunjavanja obrazaca koja su svesna uloga, na primer, usmeravanje korisnika ka poljima za koja su odgovorni, ili aktiviranje uslovne logike na osnovu toga ko popunjava obrazac i u kojem svojstvu.

function onStartFilling(event) {
  const roles = event.data;
  console.log("Uloge:", roles);
}

const config = {
  // ...
  events: {
    onStartFilling,
  },
};
const docEditor = new DocsAPI.DocEditor("placeholder", config);

Ispravka curenja memorije u destroyEditor

Curenje memorije u destroyEditor metodi je ispravljeno. Prethodno, pozivanje destroyEditor nije potpuno čišćenje dodeljenih resursa. Ako vaša aplikacija često kreira i uništava instance uređivača, kao u postavkama aplikacija jedne stranice ili radnim tokovima za pregled dokumenata, ova ispravka direktno poboljšava memorijski otisak vaše integracije tokom vremena.

Uklonjeno polje

Zastarelo editorConfig.customization.commentAuthorOnly polje je uklonjeno. Ako vaša integracija još uvek koristi ovaj parametar, sada je pravo vreme da ga uklonite kako biste izbegli neočekivano ponašanje.

Logovanje komandi dodataka za lakše otklanjanje grešaka

Jedan od najpraktičnijih dodataka za programere dodataka je logovanje komandi dodataka. Omogućite dijagnostički izlaz komandi dodataka direktno u konzoli pretraživača. Ako ste proveli vreme otklanjajući greške u ponašanju dodataka pogađajući koje komande zapravo pokreću, ova funkcija uklanja značajnu količinu tog trenja. Pruža vam direktan uvid u tok izvođenja dodatka bez potrebe za instrumentacijom vašeg sopstvenog logovanja.

Blokiranje specifičnih dodataka prilikom učitavanja

Novi editorConfig.plugins.disable parametar vam omogućava da sprečite učitavanje specifičnih dodataka prilikom inicijalizacije uređivača. Ovo je korisno kada ugrađujete uređivač u kontrolisano okruženje i želite da ograničite funkcionalnost na ono što je relevantno za vaše korisnike, a da ne morate menjati same datoteke dodataka. To je čistiji pristup na nivou konfiguracije za upravljanje površinom dodataka.

Pogledajte kompletan dnevnik promena za Docs API

ONLYOFFICE Plugins i Macros API 9.4

Metode kontrole kursora

Dodate su dve nove metode u window.Asc.plugin.executeMethod za Document API:

• MoveCursorToField: premešta kursor na određeno polje obrasca;
• MoveCursorOutsideField: premešta kursor na poziciju van trenutnog polja.

Asc.plugin.executeMethod("MoveCursorToField", [fieldId, true]);

Asc.plugin.executeMethod("MoveCursorOutsideField", [fieldId, false]);

Ove metode su posebno korisne za dodatke koji vode korisnike kroz popunjavanje obrazaca ili automatizuju navigaciju polje po polje u dokumentima. Umesto da se oslanjate na interakciju korisnika za kretanje kroz polja, vaš dodatak može programski kontrolisati postavljanje kursora.

Poboljšana kontrola StartAction i EndAction

StartAction metoda prima dva nova parametra: lockScroll i keepSelection. EndAction metoda dobija scrollToTarget i cancel. Zajedno, ovo daje dodacima bolju kontrolu nad stanjem uređivača tokom izvršenja makronaredbi. Možete sačuvati izbor korisnika, sprečiti neželjeno pomeranje tokom automatizovanih operacija, ili čisto otkazati niz akcija — sve od kojih doprinose stabilnijem i predvidivijem iskustvu dodatka.

Pogledajte kompletni dnevnik promena za Plugins i Macros API

Office JavaScript API 9.4

Ovo je najopsežniji deo izdanja 9.4. Office JavaScript API dobija nove mogućnosti u operacijama sa dokumentima, upravljanju podacima u tabelama, kontrolama obrazaca i još mnogo toga. Pogledajte celu listu novih metoda

Spajanje dokumenata

Nova Api/MergeDocuments metoda je dodata u Document API. Ovo vam omogućava da spojite više dokumenata u jedan – sposobnost koja je često zahtevala automatizaciju kao što su generisanje izveštaja, sastavljanje ugovora i obrada dokumenata u serijama.

Unified Color API u svim uređivačima

Api/Color metoda je dostupna u Document, Spreadsheet, Presentation i PDF API-jima. Imajući dosledan kolaž boja kroz sve četiri vrste uređivača pojednostavljuje kod koji treba da primeni stilizovanje preko različitih formata dokumenata. Više vam nije potrebna logika za upravljanje bojama specifična za format za uobičajene operacije.

Podrška za obrazac za potpis

Verzija 9.4 uvodi ApiSignatureForm klasu, dostupnu i u Document API i u Form API. Uz to dolaze GetValue i SetValue metode za čitanje i pisanje podataka o polju za potpis. Ovo otvara programsku obradu polja za potpis koja je korisna za radne tokove koji treba da unapred popune, verifikuju ili izvuku podatke o potpisu kao deo šireg procesa obrade dokumenata.

// GetValue metoda ApiSignatureForm vraća podatke o slici potpisa smeštene u obrascu.

// Kreirajte obrazac za potpis, dodajte ga u dokument i pročitajte njegovu trenutnu vrednost.

let doc = Api.GetDocument();
let signatureForm = Api.CreateSignatureForm({"key": "Potpis", "tip": "Molimo potpišite ovde", "required": true, "placeholder": "Potpis"});
signatureForm.Value = "https://static.onlyoffice.com/assets/docs/samples/img/onlyoffice_logo.png";
let paragraph = doc.GetElement(0);
paragraph.AddElement(signatureForm);
let value = signatureForm.GetValue();
paragraph = Api.CreateParagraph();
paragraph.AddText("Vrednost obrasca za potpis: " + value);
doc.Push(paragraph);

Pored toga, nova Api/CreateSignatureForm metoda u Form API vam omogućava da kreirate polja obrasca za potpis iz temelja putem koda, umesto da se oslanjate na ručno umetanje.

Otkrivanje stanja obrasca

ApiFormBase/IsFilled metoda, dodata u Document API i Form API, omogućava vam da proverite da li je dato polje obrasca popunjeno. Ovo je jednostavan ali važan dodatak za svaku logiku validacije ili predaje. Istražite stanje popunjenosti obrasca bez direktnog parsiranja sadržaja polja.

Inspekcija isticanja obrasca

Dve nove metode (ApiDocument/GetFormsHighlight i ApiDocument/GetControlsHighlight) su dostupne u Document i Form API. Ovo vam omogućava da preuzmete trenutna podešavanja isticanja primenjena na poljima obrazaca i kontrolama sadržaja. Ako vaša integracija upravlja konfiguracijom prikaza obrazaca ili treba da odražava stanje isticanja u spoljnim UI elementima, ove metode pružaju pristup koji je prethodno nedostajao.

Opširni API za objekte lista u tabelama

Ovo je najbogatiji dodatak u 9.4. Spreadsheet API uključuje punu ApiListObject klasu za rad sa strukturiranim objektima tabele (objekti liste), zajedno sa podržavajućim klasama za kolone, redove i sortiranje.

Ključne mogućnosti uključuju:

• Kreiranje i preuzimanje objekata liste putem ApiWorksheet/AddListObject i ApiWorksheet/GetListObjects
• Čitanje i pisanje svojstava tabela kao što su naziv, prikazni naziv, alternativni tekst, stil, zaglavlja, ukupni zbir i postavke automatskog filtra
• Pristupanje opsegu tabela uključujući redove zaglavlja, opsege podataka i redove ukupnog zbira
• Upravljanje kolonama i redovima putem ApiListColumn i ApiListRow, sa metodama za nazive, indekse, opsege, kalkulaciju ukupnog zbira i brisanje
• Podrška za sortiranje putem novog ApiSort, ApiSortFields, i ApiSortField klasa — pokriva pravac sortiranja, poređenje velikih i malih slova, kriterijumi sortiranja (vrednost ili boja), prioritet i još mnogo toga

Ako vaša integracija uključuje bilo kakvo strukturirano upravljanje podacima u tabelama kao što su uvozi podataka, dinamičko kreiranje tabela, generisanje izveštaja. Ova dopuna značajno proširuje šta možete učiniti bez traženja od korisnika da ručno manipulišu tabelama.

Nove metode za popunjavanje tabela i formula

Četiri metodе za pravac popunjavanja su dodate u ApiRange: FillDown, FillUp, FillRight, FillLeft.

One reflektuju ponašanje popunjavanja tabela koje korisnici pokreću ručno, sada dostupno za programsku upotrebu. U kombinaciji sa novom ApiRange/SetFormula metodom, možete izgraditi automatizaciju koja dinamički konstruira opsege vođene formulama. Korisno je za generisane izveštaje, šablonske tabele, i automatizaciju unosa podataka.

Metoda Api/GetDefNames je takođe dodata u Spreadsheet API, omogućavajući pristup definisanim nazivima (imenovanim opsezima) u radnoj knjizi.

Kontrole formatiranja teksta u obrascu

ApiTextForm klasa dobija četiri nove metode u Document i Form API:

• GetFormat/SetFormat: pročitajte i primenite masku formata na polje teksta
• GetAllowedSymbols/SetAllowedSymbols: kontrolišite koje karaktere korisnici mogu uneti

Ove su ključne za izgradnju obrazaca za unos podataka sa validacijom, na primer, primenom formata datuma, ograničavanje unosa na numeričke karaktere, ili primenu prilagođenih maski za brojeve telefona ili identifikacione brojeve.

Inspekcija svojstava pasusa

Set Get metoda je dodat u ApiParaPr u Document API, pokrivajući:

• Svojstva granice: gornja, leva, desna, donja, između
• Paginacija: GetKeepLines, GetKeepNext, GetPageBreakBefore, GetWidowControl
• Lista: GetNumPr
• Tabovi: GetTabs
• Razmak: GetContextualSpacing

Ovo popunjava dugogodišbju prazninu. Mogli ste programaski podesiti mnoga od ovih svojstava, ali njihovo povratno čitanje nije uvek bilo moguće. Možete inspektovati formatiranje pasusa bez oslanjanja na zaobilazna rešenja, što je posebno korisno za alate za analizu dokumenata i skripte za validaciju šablona.

Boja kontrole sadržaja

ApiInlineLvlSdt klasa u Document API podržava SetColor i GetColor metode. Možete dodeliti i čitati boje isticanja za inline kontrole sadržaja, olakšavajući izgradnju vizuelno različitih iskustava obrazaca ili isticanje kontrole na osnovu njihovog stanja.

// Kako mogu promeniti boju inline kontrole sadržaja u dokumentu?

// Primeni određenu RGB boju da vizuelno razlikuje kontrolu sadržaja u dokumentu.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
let inlineLvlSdt = Api.CreateInlineLvlSdt();
let run = Api.CreateRun();
run.AddText("Ovo je inline tekstualna kontrola sadržaja sa plavom oznakom.");
inlineLvlSdt.AddElement(run, 0);
inlineLvlSdt.SetColor(Api.RGB(0, 0, 255));
paragraph.AddInlineLvlSdt(inlineLvlSdt);