---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Imagem - com escopo, global

# Imagem - com escopo, global {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 min. de leitura

Cria um objeto de imagem que representa uma imagem e sua inserção de layout em um PDF. Habilita a definição de atributos como escala, alinhamento e cor da borda.

Esta API faz parte do plug-in ServiceNow PDF Generator Utilities (com.snc.apppdfgenerator) e é fornecida no namespace `sn_pdfgeneratorutils`. O plug-in é ativado por padrão.

Esta API é um componente usado com a [API de documento](https://servicenow-prod.fluidtopics.net/GfzkXxoz~DU2Zt1bfpGPXA#DocumentBothAPI "A API Document fornece métodos para inicializar um PDF, adicionar conteúdo e fechar o PDF. Depois de adicionar conteúdo, o documento pode ser anexado a um registro de destino.") para gerar um PDF.  
Você pode adicionar uma imagem a um PDF usando um dos seguintes métodos:

* [Célula -- addImage (imagem imagem)](https://servicenow-prod.fluidtopics.net/KSht1b2wJB1J44IMkFRMSA#Cell-addImage_O "Adiciona uma imagem a uma célula de tabela.") -- Adiciona uma imagem a uma célula da tabela
* [Tabela -- addImageCell(Image image)](https://servicenow-prod.fluidtopics.net/TRzRswGVxJ_rNB0u20U9rg#Table-addImageCell_O "Adiciona uma célula que contém uma imagem à tabela.") -- Adiciona uma célula que contém uma imagem a uma tabela.
* [Document -- addImage (imagem imagem)](https://servicenow-prod.fluidtopics.net/GfzkXxoz~DU2Zt1bfpGPXA#Document-addImage_O "Adiciona uma imagem a um documento.") - Adiciona uma imagem a uma página
{#ImageBothAPI__ul_jkh_55q_s4b}

## Imagem - Imagem (cadeia de caracteres attachmentSysId) {#ariaid-title2}

Instancia um novo objeto de imagem. Usado para verificar se um anexo de imagem existe e está disponível para modificação.
{#Image-Image_S__table_twm_hjk_34b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| attachmentSysId | Cadeia de caracteres | Sys_id de uma imagem na tabela Anexos \[sys_attachment\]. |
[Tabela 1. Parâmetros]

{#Image-Image_S__table_twm_hjk_34b}  
O exemplo a seguir mostra como criar um objeto de imagem.

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

## Imagem -- scaleAbsolute (largura do número, altura do número) {#ariaid-title3}

Dimensiona uma imagem para tamanhos absolutos de largura e altura. Esta configuração não preserva a proporção largura-altura da imagem e pode resultar em estiramento indesejado se as configurações não forem precisas.
Para dimensionar para um tamanho absoluto que preserva a proporção largura-altura de uma imagem, use o método [scaleToFit()](https://servicenow-prod.fluidtopics.net/tBijnhDQ~V_~auzllEpR_A#Image-scaleToFit_N_N "Dimensiona uma imagem para um tamanho absoluto enquanto preserva a proporção largura-altura.").
{#Image-scaleAbsolute_N_N__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| largura | Número | Largura da imagem em pontos. |
| altura | Número | Altura da imagem em pontos. |
[Tabela 2. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 3. Retorna]

{#Image-scaleAbsolute_N_N__table_wv5_52h_44b}  
O exemplo a seguir mostra como adicionar uma imagem a um PDF com configurações absolutas de largura e altura.

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

## Imagem -- scaleToFit(largura do número, altura do número) {#ariaid-title4}

Dimensiona uma imagem para um tamanho absoluto enquanto preserva a proporção largura-altura.
A saída resultante varia de acordo com a proporção da imagem. Se os valores de parâmetro de largura e altura não corresponderem à proporção da imagem, um valor será renderizado menor na saída do que o valor fornecido.
{#Image-scaleToFit_N_N__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| largura | Número | Largura máxima da imagem em pontos. |
| altura | Número | Altura máxima da imagem em pontos. |
[Tabela 4. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 5. Retorna]

{#Image-scaleToFit_N_N__table_wv5_52h_44b}  
O exemplo a seguir mostra como inserir uma imagem dimensionada para caber usando o método [Célula -- addImage()](https://servicenow-prod.fluidtopics.net/KSht1b2wJB1J44IMkFRMSA#Cell-addImage_O "Adiciona uma imagem a uma célula de tabela.").

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

## Imagem -- setAutoScale(Boolean value) {#ariaid-title5}

Habilita o dimensionamento de largura e altura para uma página ou célula enquanto retém as dimensões.
{#Image-setAutoScale_B__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| valor | Booliano | Sinalizador que indica se uma imagem deve ser dimensionada automaticamente. Valores válidos: * verdadeiro: dimensiona automaticamente a imagem * falso: a imagem não é dimensionada {#Image-setAutoScale_B__ul_drr_bbr_s4b} Padrão: falso |
[Tabela 6. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 7. Retorna]

{#Image-setAutoScale_B__table_wv5_52h_44b}  
O exemplo a seguir mostra como adicionar uma imagem a um PDF com escalonamento automático. A imagem é adicionada usando o método [Table -- addImageCell()](https://servicenow-prod.fluidtopics.net/TRzRswGVxJ_rNB0u20U9rg#Table-addImageCell_O "Adiciona uma célula que contém uma imagem à tabela.").

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

## Imagem -- setColoredBorder(Cor, largura do número) {#ariaid-title6}

Define uma borda em um PDF na cor especificada.
{#Image-setColoredBorder_O_N__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| cor | [Cor](https://servicenow-prod.fluidtopics.net/3HDiHdJmpVjIjUYOrdT0Mg#ColorBothAPI "Cria um objeto Cor usado para definir atributos de cor que você pode aplicar a elementos em um PDF; como células, tabelas e linhas.") | Cor da borda da imagem. |
| largura | Número | Largura da borda em pontos. |
[Tabela 8. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 9. Retorna]

{#Image-setColoredBorder_O_N__table_wv5_52h_44b}  
O exemplo a seguir mostra como definir uma borda vermelha de cinco pontos em uma imagem.

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

## Imagem -- setHorizontalAlignment(cadeia de caracteres alinhamento) {#ariaid-title7}

Define o alinhamento horizontal da imagem.
{#Image-setHorizontalAlignment_S__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| alinhamento | Cadeia de caracteres | Posiciona o alinhamento da imagem em uma página ou elemento de bloco. Valores válidos: * Centro * Esquerda * Direita {#Image-setHorizontalAlignment_S__ul_rn3_wvq_s4b} Padrão: esquerdo |
[Tabela 10. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 11. Retorna]

{#Image-setHorizontalAlignment_S__table_wv5_52h_44b}  
O exemplo a seguir mostra como adicionar uma imagem centralizada em uma página PDF.

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

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

Define uma imagem para não ter borda.
{#Image-setNoBorder__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 12. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 13. Retorna]

{#Image-setNoBorder__table_wv5_52h_44b}  
O exemplo a seguir mostra como adicionar uma imagem a um documento sem borda.

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