Durchsuchbare Dokumentation aufrufen

Zurück zur Dokumentationsübersicht

JavaScript-Bibliothek common/svg

Diese Bibliothek bietet Funktionen zum Wandeln von SVG-Dateien in JPG und PNG.

Verwendung

Binden Sie die Bibliothek stets am Anfang eines Skripts ein:

let svg = require('common/svg');

let svgS = '...PUT-IN-SOME-SVG-XML...';
svg.svgToJpg(svgS, output-agorum-core-object, {
  width: 800,
  quality: 0.9
});

Funktionen

svgToJpg

Konvertiert eine SVG-Datei in eine JPG-Datei.


Aufruf

svg.svgToJpg(input, output, options);


Parameter

Parameter Beschreibung
input Definiert die SVG-Datei.

Folgende Typen sind möglich:
  • agorum core-Objekt
  • String
  • inputStream
output Definiert die JPG-Datei.

Folgende Typen sind möglich:
  • agorum core-Objekt
  • outputStream
options Definiert eine Struktur, die folgende Werte enthalten kann:

width (optional)
Definiert einen Hinweis auf die zu erzeugende Breite. Standard wird automatisch bestmöglich ermittelt.

height (optional)
Definiert einen Hinweis auf die zu erzeugende Höhe. Standard wird automatisch bestmöglich ermittelt.

quality (optional)
Definiert einen Wert zwischen 0 (niedrig) und 1 (hoch) für die Qualität der JPG-Datei (Standard = 0.8 (80 %).

Das Ergebnis wird in das in output angegeben Objekt geschrieben.

svgToPng

Konvertiert eine SVG-Datei in eine PNG-Datei.


Aufruf

svg.svgToPng(input, output, options);


Parameter

Parameter Beschreibung
input Definiert die SVG-Datei.

Folgende Typen sind möglich:
  • agorum core-Objekt
  • String
  • inputStream
output Definiert die JPG-Datei.

Folgende Typen sind möglich:
  • agorum core-Objekt
  • outputStream
options Definiert eine Struktur, die folgende Werte enthalten kann:

width (optional)
Definiert einen Hinweis auf die zu erzeugende Breite. Standard wird automatisch bestmöglich ermittelt.

height (optional)
Definiert einen Hinweis auf die zu erzeugende Höhe. Standard wird automatisch bestmöglich ermittelt.

Das Ergebnis wird in das in output angegeben Objekt geschrieben.

Komplettes Beispiel

let svg = require('common/svg');
let objects = require('common/objects');

let target = objects.find('home:myFiles');

// create a sample output file in myFiles of the current user
let jpg = objects.create('file', {
  name: 'test-svg-jpg-' + new Date().getTime() + '.jpg',
  target: target
});

// the agorum core logo as svg
let svgS = '<?xml version="1.0" encoding="utf-8"?><svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 501.4 500" style="enable-background:new 0 0 501.4 500;" xml:space="preserve"><style type="text/css">.st0{fill:#0069B5;} .st1{fill:#003F85;} .st2{fill:#5696E8;}</style><rect x="200.7" y="200.9" transform="matrix(0.7071 -0.7071 0.7071 0.7071 -103.9823 250.782)" class="st0" width="100" height="100"/><polygon class="st1" points="237.6,50 179.5,108.1 215.3,143.9 309.3,50 "/><polygon class="st2" points="262.8,450 320.9,391.9 286.1,357 193.1,450 "/><polygon class="st1" points="108.8,250.5 180,179.3 144.2,143.5 73,214.6 50.7,236.9 50.7,263.1 179.5,391.9 214.9,356.5 "/><polygon class="st2" points="321.4,108.6 286.1,143.9 392.6,250.5 321.9,321.2 357.2,356.5 427.9,285.8 450.7,263.1 450.7,237.9 "/></svg>';

// create jpg with 800 pixel width
svg.svgToJpg(svgS, jpg, {
  width: 800,
  quality: 0.9
});