---
sourceDocument: Xanadu-API-Referenz
sourceDocumentLink: https://www.servicenow.com/docs/r/de-DE/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - de-DE

ft:publication_title :

    - Xanadu-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Bild: bereichsbezogen, global

# Bild: bereichsbezogen, global {#ariaid-title1}

* Freigeben Version: Xanadu
* 
* Aktualisiert 1. August 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 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](https://www.servicenow.com/docs/CveG5U0vsM3q8bxY3KrZQg#DocumentBothAPI "Die Dokumenten -API bietet Methoden zum Initialisieren einer PDF-Datei, zum Hinzufügen von Inhalten und zum Schließen der PDF-Datei. Nach dem Hinzufügen von Inhalt kann das Dokument an einen Zieldatensatz angehängt werden.") zum Generieren einer PDF-Datei verwendet wird.  
Sie können ein Bild mit einer der folgenden Methoden zu einer PDF-Datei hinzufügen:

* [Zelle -- addImage(Image image)](https://www.servicenow.com/docs/LMrYJbiowSIzb00C5iDTfQ#Cell-addImage_O "Fügt einer Tabellenzelle ein Bild hinzu.") -- Fügt einer Tabellenzelle ein Bild hinzu
* [Tabelle -- addImageCell(Image image)](https://www.servicenow.com/docs/QiSKJtYX~SupHue~~byC3w#Table-addImageCell_O "Fügt der Tabelle eine Zelle hinzu, die ein Bild enthält.") -- Fügt einer Tabelle eine Zelle hinzu, die ein Bild enthält.
* [Dokument -- addImage(Image image)](https://www.servicenow.com/docs/CveG5U0vsM3q8bxY3KrZQg#Document-addImage_O "Fügt einem Dokument ein Bild hinzu.") Fügt einer Seite ein Bild hinzu
{#ImageBothAPI__ul_jkh_55q_s4b}

## Bild: Image(String AttachmentSysId) {#ariaid-title2}

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

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

{#Image-Image_S__table_twm_hjk_34b}  
Das folgende Beispiel zeigt, wie ein Image- Objekt erstellt wird.

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

## Bild -- scaleAbsolute(Zahlenbreite, Zahlenhöhe) {#ariaid-title3}

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()](https://www.servicenow.com/docs/HY0TKCJFZB~mvFf1YM_zDA#Image-scaleToFit_N_N "Skaliert ein Bild auf eine absolute Größe, während das Breiten-Höhe-Verhältnis beibehalten wird.") ".
{#Image-scaleAbsolute_N_N__table_vv5_52h_44b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| width | Nummer | Bildbreite in Punkten. |
| height | Nummer | Bildhöhe in Punkten. |
[Tabelle : 2. Parameter]

{#Image-scaleAbsolute_N_N__table_vv5_52h_44b} {#Image-scaleAbsolute_N_N__table_wv5_52h_44b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 3. Ergebnisse]

{#Image-scaleAbsolute_N_N__table_wv5_52h_44b}  
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) {#ariaid-title4}

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.
{#Image-scaleToFit_N_N__table_vv5_52h_44b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| width | Nummer | Maximale Bildbreite in Punkten. |
| height | Nummer | Maximale Bildhöhe in Punkten. |
[Tabelle : 4. Parameter]

{#Image-scaleToFit_N_N__table_vv5_52h_44b} {#Image-scaleToFit_N_N__table_wv5_52h_44b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 5. Ergebnisse]

{#Image-scaleToFit_N_N__table_wv5_52h_44b}  
Das folgende Beispiel zeigt, wie Sie ein Bild einfügen, das mit der Methode [Zelle -- addImage() angepasst wurde](https://www.servicenow.com/docs/LMrYJbiowSIzb00C5iDTfQ#Cell-addImage_O "Fügt einer Tabellenzelle ein Bild hinzu.").

    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) {#ariaid-title5}

Aktiviert die Skalierung der Breite und Höhe einer Seite oder Zelle unter Beibehaltung der Abmessungen.
{#Image-setAutoScale_B__table_vv5_52h_44b__entry__3}

| 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 {#Image-setAutoScale_B__ul_drr_bbr_s4b} Standardwert: false |
[Tabelle : 6. Parameter]

{#Image-setAutoScale_B__table_vv5_52h_44b} {#Image-setAutoScale_B__table_wv5_52h_44b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 7. Ergebnisse]

{#Image-setAutoScale_B__table_wv5_52h_44b}  
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()](https://www.servicenow.com/docs/QiSKJtYX~SupHue~~byC3w#Table-addImageCell_O "Fügt der Tabelle eine Zelle hinzu, die ein Bild enthält.") " 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) {#ariaid-title6}

Legt einen Rahmen für eine PDF-Datei in der angegebenen Farbe fest.
{#Image-setColoredBorder_O_N__table_vv5_52h_44b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Farbe | [Farbe](https://www.servicenow.com/docs/TxRHCwvy~USckaZaKz_l2A#ColorBothAPI "Erstellt ein Farbobjekt, das zum Definieren von Farbattributen verwendet wird, die Sie auf Elemente in einer PDF-Datei anwenden können; wie Zellen, Tabellen und Zeilen.") | Farbe des Bildrahmens. |
| width | Nummer | Breite des Rahmens in Punkten. |
[Tabelle : 8. Parameter]

{#Image-setColoredBorder_O_N__table_vv5_52h_44b} {#Image-setColoredBorder_O_N__table_wv5_52h_44b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 9. Ergebnisse]

{#Image-setColoredBorder_O_N__table_wv5_52h_44b}  
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) {#ariaid-title7}

Legt die horizontale Ausrichtung des Bilds fest.
{#Image-setHorizontalAlignment_S__table_vv5_52h_44b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Ausrichtung | Zeichenfolge | Positioniert die Bildausrichtung auf einer Seite oder einem Blockelement. Gültige Werte: * Mitte * Links * Rechts {#Image-setHorizontalAlignment_S__ul_rn3_wvq_s4b} Standard: Links |
[Tabelle : 10. Parameter]

{#Image-setHorizontalAlignment_S__table_vv5_52h_44b} {#Image-setHorizontalAlignment_S__table_wv5_52h_44b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 11. Ergebnisse]

{#Image-setHorizontalAlignment_S__table_wv5_52h_44b}  
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() {#ariaid-title8}

Legt ein Bild so fest, dass es keinen Rahmen hat.
{#Image-setNoBorder__table_vv5_52h_44b__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 12. Parameter]

{#Image-setNoBorder__table_vv5_52h_44b} {#Image-setNoBorder__table_wv5_52h_44b__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 13. Ergebnisse]

{#Image-setNoBorder__table_wv5_52h_44b}  
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");