Image: Scoped, Global

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 4 Minuten Lesedauer

    • Erstellt ein Image-Objekt, das ein Bild darstellt, und dessen Layout in eine PDF-Datei einfügt. Ermöglicht die Definition von Attributen wie Skalierung, Ausrichtung und Rahmenfarbe.

    Diese API ist Teil des Plugins ServiceNow PDF Generation 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:

    Image – Image(String attachmentSysId)

    Instantiiert 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 Image 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>");

    Image – ScaleAbsolute(Number width, Number height)

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

    Um auf eine absolute Größe zu skalieren, die das Breiten-Höhen-Verhältnis eines Bildes beibehält, verwenden Sie die SkalaToFIT()- Methode.

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

    Das folgende Beispiel zeigt, wie Sie ein Bild zu einer PDF-Datei mit Einstellungen für absolute Breite und Höhe 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");

    Image – ScaleToFit(Number width, Number height)

    Skaliert ein Bild auf eine absolute Größe unter Beibehaltung des Breiten-Höhen-Verhältnisses.

    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 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. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie ein Bild eingefügt wird, das mit der Methode „Cell – addImage() “ skaliert 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");

    Image – setAutoScale(Boolean value)

    Ermöglicht die Skalierung von 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:
    • true: Skaliert das Bild automatisch
    • false: Bild wird nicht skaliert

    Standardwert: false
    Tabelle : 7. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie ein Bild zu einer PDF-Datei mit automatischer Skalierung hinzufügen. Das Bild wird mit der Methode Table – 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(Farbe color, Number width)

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

    Tabelle : 8. Parameter
    Name Typ Beschreibung
    Farbe Farbe Bildrahmenfarbe.
    width Nummer Breite des Rahmens in Punkten.
    Tabelle : 9. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie einen roten Fünf-Punkte-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");

    Image – setHorizontalAlignment(String ausgerichtet)

    Legt die horizontale Ausrichtung des Bildes fest.

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

    Standard: Links
    Tabelle : 11. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie ein zentriertes Bild auf einer PDF-Seite hinzugefügt wird.

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