---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Bild: Umfang, Global

# Bild: Umfang, Global {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 Minuten Lesedauer

Erstellt ein Bildobjekt, das ein Bild und dessen Layouteinfügung in einer PDF darstellt. Aktiviert das Definieren von Attributen wie Skala, Ausrichtung und Rahmenfarbe.

Diese API ist Teil von ServiceNowPDF-Generierungsdienstprogramme-Plugin (com.snc.apppdfgenerator) und wird in bereitgestellt `sn_pdfgeneratorutils `Namespace. Das Plugin ist standardmäßig aktiviert.

Diese API ist eine Komponente, die mit verwendet wird [Dokument-API](https://servicenow-prod.fluidtopics.net/tUwTjwhc8qeiH0if1DLMOQ#DocumentBothAPI "Die Dokument Die API bietet Methoden zum Initialisieren einer PDF, Hinzufügen von Inhalten und Schließen der PDF. Nach dem Hinzufügen von Inhalten kann das Dokument an einen Zieldatensatz angehängt werden.")Dient zum Generieren einer PDF.  
Sie können einer PDF-Datei ein Bild mit einer der folgenden Methoden hinzufügen:

* [Zelle -- addImage(Image)](https://servicenow-prod.fluidtopics.net/F5hH8hZBOdeJyFcXlx9jqQ#Cell-addImage_O "Fügt einer Tabellenzelle ein Bild hinzu.") -- Fügt einer Tabellenzelle ein Bild hinzu
* [Tabelle -- addImageCell(Image-Image)](https://servicenow-prod.fluidtopics.net/iootwUjgf5Rz2Gqrk_PFfA#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)](https://servicenow-prod.fluidtopics.net/tUwTjwhc8qeiH0if1DLMOQ#Document-addImage_O "Fügt einem Dokument ein Bild hinzu.") -- Fügt einer Seite ein Bild hinzu
{#ImageBothAPI__ul_jkh_55q_s4b}

## Image -- Image (ZeichenfolgenanhangSysId) {#ariaid-title2}

Instanziiert eine neue Bild Objekt. Wird verwendet, um zu überprüfen, ob ein Bildanhang vorhanden ist 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 erstellt wird Bild Objekt.

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

## Bild -- scaleAbsolute (Nummernbreite, Nummernhöhe) {#ariaid-title3}

Skaliert ein Bild auf absolute Breiten- und Höhengrößen. Diese Einstellung behält das Breiten-Höhen-Verhältnis des Bildes nicht bei und kann zu unerwünschter Dehnung führen, wenn die Einstellungen nicht genau sind.
Verwenden Sie zum Skalieren auf eine absolute Größe, die das Breiten-Höhen-Verhältnis eines Bildes beibehält [SkalierenToFit()](https://servicenow-prod.fluidtopics.net/5axutzT9b2IpOesPLwNECA#Image-scaleToFit_N_N "Skaliert ein Bild auf eine absolute Größe, wobei das Verhältnis von Breite und Höhe beibehalten wird.")Methode.
{#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. Rückgaben]

{#Image-scaleAbsolute_N_N__table_wv5_52h_44b}  
Das folgende Beispiel zeigt, wie ein Bild zu einer PDF-Datei mit absoluten Breiten- und Höheneinstellungen hinzugefügt wird.

    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 -- scaleToFit (Nummernbreite, Nummernhöhe) {#ariaid-title4}

Skaliert ein Bild auf eine absolute Größe, wobei das Verhältnis von Breite und Höhe 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 als der angegebene Wert gerendert.
{#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. Rückgaben]

{#Image-scaleToFit_N_N__table_wv5_52h_44b}  
Das folgende Beispiel zeigt, wie ein Bild eingefügt wird, das mithilfe von skaliert ist [Zelle -- addImage()](https://servicenow-prod.fluidtopics.net/F5hH8hZBOdeJyFcXlx9jqQ#Cell-addImage_O "Fügt einer Tabellenzelle ein Bild hinzu.")Methode.

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

Aktiviert die Skalierung von Breite und Höhe auf eine 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} Standard: Falsch |
[Tabelle : 6. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 7. Rückgaben]

{#Image-setAutoScale_B__table_wv5_52h_44b}  
Das folgende Beispiel zeigt, wie ein Bild mit automatischer Skalierung zu einer PDF-Datei hinzugefügt wird. Das Bild wird mit hinzugefügt [Tabelle -- addImageCell()](https://servicenow-prod.fluidtopics.net/iootwUjgf5Rz2Gqrk_PFfA#Table-addImageCell_O "Fügt der Tabelle eine Zelle hinzu, die ein Bild enthält.")Methode.

    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://servicenow-prod.fluidtopics.net/cmxeBX8i9ErCpDNgnDoZ1g#ColorBothAPI "Erstellt ein Farbobjekt, das zum Definieren von Farbattributen verwendet wird, die Sie auf Elemente in einer PDF anwenden können, z. B. Zellen, Tabellen und Linien.") | Bildrahmenfarbe. |
| 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. Rückgaben]

{#Image-setColoredBorder_O_N__table_wv5_52h_44b}  
Das folgende Beispiel zeigt, wie ein roter Rahmen mit fünf Punkten für ein Bild festgelegt wird.

    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. Rückgaben]

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

## Image -- setNoBorder() {#ariaid-title8}

Legt fest, dass ein Bild 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. Rückgaben]

{#Image-setNoBorder__table_wv5_52h_44b}  
Das folgende Beispiel zeigt, wie einem Dokument ohne Rahmen ein Bild 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>");

    image.setNoBorder();

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


