Bild: bereichsbezogen, global

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 4 Minuten Lesedauer

    • Erstellt ein Bildobjekt, das ein Bild und dessen Layout in einer PDF-Datei einfügt. Ermöglicht das Definieren von Attributen wie Skala, Ausrichtung und Rahmenfarbe.

    Diese API ist Teil des Plugins ServiceNow PDF Generierung Utilities (com.snc.apppdfgenerator) und wird im Namespace sn_pdfgeneratorutils bereitgestellt. Das Plugin ist standardmäßig aktiviert.

    Diese API ist eine Komponente, die mit der Dokument-API zum Generieren einer PDF-Datei verwendet wird.

    Sie können ein Bild mit einer der folgenden Methoden zu einer PDF-Datei hinzufügen:

    Bild: Image(String AttachmentSysId)

    Instanziiert ein neues Image- Objekt. Wird verwendet, um zu überprüfen, ob ein Bildanhang vorhanden und zur Änderung verfügbar ist.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    attachmentSysId Zeichenfolge Sys_id eines Images in der Tabelle „Anhänge“ [sys_attachment].

    Das folgende Beispiel zeigt, wie ein Image- Objekt erstellt wird.

    var image = new sn_pdfgeneratorutils.Image("<sys_id>");

    Bild – scaleAbsolute(Zahlenbreite, Zahlenhöhe)

    Skaliert ein Bild auf die absolute Breite und Höhe. Diese Einstellung behält das Breiten-Höhe-Verhältnis des Bildes nicht bei und kann zu unerwünschter Dehnung führen, wenn die Einstellungen nicht präzise sind.

    Um auf eine absolute Größe zu skalieren, die das Breiten-Höhe-Verhältnis eines Bilds beibehält, verwenden Sie die Methode „scaleToPass()“.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    width Nummer Bildbreite in Punkten.
    height Nummer Bildhöhe in Punkten.
    Tabelle : 3. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie ein Bild mit den Einstellungen für absolute Breite und Höhe zu einer PDF-Datei hinzufügen.

    var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);

var scaleAbsPic = new sn_pdfgeneratorutils.Image("<img_sys_id>");
scaleAbsPic.scaleAbsolute(25,50);

document.addImage(scaleAbsPic);

document.saveAsAttachment("incident", "<record_sys_id>", "docWithImg.pdf");

    Bild – scaleToPass(Zahlenbreite, Zahlenhöhe)

    Skaliert ein Bild auf eine absolute Größe, während das Breiten-Höhe-Verhältnis beibehalten wird.

    Die resultierende Ausgabe variiert je nach Bildseitenverhältnis. Wenn die Parameterwerte für Breite und Höhe nicht mit dem Bildseitenverhältnis übereinstimmen, wird ein Wert in der Ausgabe kleiner gemacht als der angegebene Wert.

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    width Nummer Maximale Bildbreite in Punkten.
    height Nummer Maximale Bildhöhe in Punkten.
    Tabelle : 5. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie ein Bild einfügen, das mit der Methode Zelle – addImage() angepasst wurde.

    var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
// add a table
var table = new sn_pdfgeneratorutils.Table([1,3],false);

// text for the left column
var text = "sample image";

// add a table cell for the image in the right column
var imgCell = new sn_pdfgeneratorutils.Cell(1, 1);

// add an image and set it scale-to-fit
var scaleToFitPic = new sn_pdfgeneratorutils.Image("<img_sys_id>");
scaleToFitPic.scaleToFit(90,175);

// add the image to the cell
imgCell.addImage(scaleToFitPic);
 
table.addTextCell(text);
table.addCell(imgCell);

// Here's a paragraph
var para = new sn_pdfgeneratorutils.Paragraph("The following table image uses scale to fit.");

document.addParagraph(para);
document.addTable(table);

document.saveAsAttachment("incident", "<record_sys_id>", "imgScaleToFit.pdf");

    Bild – setAutoScale(Boolean value)

    Aktiviert die Skalierung der Breite und Höhe einer Seite oder Zelle unter Beibehaltung der Abmessungen.

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    Wert Boolean

    Kennzeichnung, die angibt, ob ein Bild automatisch skaliert werden soll.

    Gültige Werte:
    • „wahr“: Skaliert das Bild automatisch
    • „falsch“: Bild wird nicht skaliert

    Standardwert: false
    Tabelle : 7. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie ein Bild mit automatischer Skalierung zu einer PDF-Datei hinzufügen. Das Bild wird mit der Methode „Tabelle – addImageCell()“ hinzugefügt.

    var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);

// Add a table
var table = new sn_pdfgeneratorutils.Table([1,2],false);

// Text in left column
var text = "sample image";

// Image in right column
var autoScaledPic = new sn_pdfgeneratorutils.Image("<image_sys_id>");
autoScaledPic.setAutoScale(true);

table.addTextCell(text);
table.addImageCell(autoScaledPic);

document.addTable(table);
document.saveAsAttachment("incident", "<record_sys_id>", "imgAutoScale.pdf");

    Bild – setColoredBorder(Farbfarbe, Zahlenbreite)

    Legt einen Rahmen für eine PDF-Datei in der angegebenen Farbe fest.

    Tabelle : 8. Parameter
    Name Typ Beschreibung
    Farbe Farbe Farbe des Bildrahmens.
    width Nummer Breite des Rahmens in Punkten.
    Tabelle : 9. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie einen fünfzackigen roten Rahmen für ein Bild festlegen.

    var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);

var borderColor = new sn_pdfgeneratorutils.Color([1.0,0.0,0.0]);
 
// declare image using sys attachment
var image = new sn_pdfgeneratorutils.Image("<imgAttachment_sys_id>");

image.setColoredBorder(borderColor, 5);

document.addImage(image);
document.saveAsAttachment("incident", "<record_sys_id>", "docWithBorderedImage.pdf");

    Bild – setHorizontalAlignment(Zeichenfolgenausrichtung)

    Legt die horizontale Ausrichtung des Bilds fest.

    Tabelle : 10. Parameter
    Name Typ Beschreibung
    Ausrichtung Zeichenfolge Positioniert die Bildausrichtung auf einer Seite oder einem Blockelement.
    Gültige Werte:
    • Mitte
    • Links
    • Rechts

    Standard: Links
    Tabelle : 11. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie ein zentriertes Bild auf einer PDF-Seite hinzufügen.

    var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
// declare image using sys attachment
var image = new sn_pdfgeneratorutils.Image("<imgAttachment_sys_id>");

String alignment = "Center";
image.setHorizontalAlignment(alignment);

document.addImage(image);
// save pdf as attachment to target record in the Incident table
document.saveAsAttachment("incident", "<sys_id>", "docWithImageCentered.pdf");

    Bild – setNoBorder()

    Legt ein Bild so fest, dass es keinen Rahmen hat.

    Tabelle : 12. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 13. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie einem Dokument ein Bild ohne Rahmen hinzufügen.

    var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
// declare image using sys attachment
var image = new sn_pdfgeneratorutils.Image("<imgAttachment_sys_id>");

image.setNoBorder();

document.addImage(image);
document.saveAsAttachment("incident", "<sys_id>", "docWithImgNoBorder.pdf");