---
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


---

# PdfPage - com escopo, global

# PdfPage - 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) 2 min. de leitura

Cria um objeto PdfPage que representa uma página PDF e seus atributos; como tamanho, largura e cor.

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.

## PdfPage - PdfPage (cadeia de caracteres pageSize, orientação de cadeia de caracteres) {#ariaid-title2}

Instancia um novo objeto PdfPage.
{#PdfPage-PdfPage_S_S__table_twm_hjk_34b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| pageSize | Cadeia de caracteres | Tamanho da página do PDF. Valores válidos: * A4 -- 595 x 842 pontos * EXECUTIVO -- 522 x 756 pontos * CARTA -- 612 x 792 pontos * Razão: 792 x 1224 pontos {#PdfPage-PdfPage_S_S__ul_dml_q2p_k4b} |
| orientação | Cadeia de caracteres | Opcional. Orientação de página em PDF. Valores válidos: * PAISAMENTO * RETRATO {#PdfPage-PdfPage_S_S__ul_igz_j3p_r4b} Padrão: RETRATO |
[Tabela 1. Parâmetros]

{#PdfPage-PdfPage_S_S__table_twm_hjk_34b}  
O exemplo a seguir mostra como criar um objeto PdfPage.

    var pdfpage = new sn_pdfgeneratorutils.PdfPage("A4", "LANDSCAPE");

## PdfPage -- getBottom() {#ariaid-title3}

Obtém a coordenada Y da borda inferior de uma página PDF.
{#PdfPage-getBottom__table_vv5_52h_44b__entry__3}

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

{#PdfPage-getBottom__table_vv5_52h_44b} {#PdfPage-getBottom__table_wv5_52h_44b__entry__2}

| Tipo | Descrição |
|-|-|
| Número | Valor decimal da coordenada Y na borda inferior da página PDF. |
[Tabela 3. Retorna]

{#PdfPage-getBottom__table_wv5_52h_44b}  
O exemplo a seguir mostra como obter a coordenada Y da borda inferior de uma página PDF.

    var pdfpage = new sn_pdfgeneratorutils.PdfPage("A4", "LANDSCAPE");
     var bottom = pdfpage.getBottom();

## PdfPage -- getLeft() {#ariaid-title4}

Obtém a coordenada X da borda esquerda de uma página PDF.
{#PdfPage-getLeft__table_vv5_52h_44b__entry__3}

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

{#PdfPage-getLeft__table_vv5_52h_44b} {#PdfPage-getLeft__table_wv5_52h_44b__entry__2}

| Tipo | Descrição |
|-|-|
| Número | Valor decimal da coordenada X na borda esquerda da página. |
[Tabela 5. Retorna]

{#PdfPage-getLeft__table_wv5_52h_44b}  
O exemplo a seguir mostra como obter a coordenada X da borda esquerda de uma página PDF.

    var pdfpage = new sn_pdfgeneratorutils.PdfPage("A4", "LANDSCAPE");
     var left = pdfpage.getLeft();

## PdfPage -- getPdfPageSize() {#ariaid-title5}

Obtém o tamanho de uma página PDF
{#PdfPage-getPdfPageSize__table_vv5_52h_44b__entry__3}

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

{#PdfPage-getPdfPageSize__table_vv5_52h_44b} {#PdfPage-getPdfPageSize__table_wv5_52h_44b__entry__2}

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

{#PdfPage-getPdfPageSize__table_wv5_52h_44b}  
O exemplo a seguir mostra como obter o tamanho da página do PDF.

    var pdfpage = new sn_pdfgeneratorutils.PdfPage("A4", "LANDSCAPE");
    var size = pdfpage.getPdfPageSize();

## PdfPage -- getRight() {#ariaid-title6}

Obtém a coordenada X da borda direita de uma página PDF.
{#PdfPage-getRight__table_vv5_52h_44b__entry__3}

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

{#PdfPage-getRight__table_vv5_52h_44b} {#PdfPage-getRight__table_wv5_52h_44b__entry__2}

| Tipo | Descrição |
|-|-|
| Número | Valor decimal da coordenada X na borda direita da página. |
[Tabela 9. Retorna]

{#PdfPage-getRight__table_wv5_52h_44b}  
O exemplo a seguir mostra como obter a coordenada X da borda direita de uma página PDF.

    var pdfpage = new sn_pdfgeneratorutils.PdfPage("A4", "LANDSCAPE");
     var right = pdfpage.getRight();

## PdfPage -- getTop() {#ariaid-title7}

Obtém a coordenada Y da borda superior de uma página PDF.
{#PdfPage-getTop__table_vv5_52h_44b__entry__3}

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

{#PdfPage-getTop__table_vv5_52h_44b} {#PdfPage-getTop__table_wv5_52h_44b__entry__2}

| Tipo | Descrição |
|-|-|
| Número | Valor decimal da coordenada Y na borda superior da página PDF. |
[Tabela 11. Retorna]

{#PdfPage-getTop__table_wv5_52h_44b}  
O exemplo a seguir mostra como obter a coordenada Y da borda superior de uma página PDF.

    var pdfpage = new sn_pdfgeneratorutils.PdfPage("A4", "LANDSCAPE");
     var top  = pdfpage.getTop();

## PdfPage -- getWidth() {#ariaid-title8}

Obtém a largura de uma página PDF.
{#PdfPage-getWidth__table_vv5_52h_44b__entry__3}

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

{#PdfPage-getWidth__table_vv5_52h_44b} {#PdfPage-getWidth__table_wv5_52h_44b__entry__2}

| Tipo | Descrição |
|-|-|
| Número | Tamanho da largura da página em pontos. |
[Tabela 13. Retorna]

{#PdfPage-getWidth__table_wv5_52h_44b}  
O exemplo a seguir mostra como recuperar a largura de uma página PDF.

    var pdfpage = new sn_pdfgeneratorutils.PdfPage("A4", "LANDSCAPE");
    var width = PdfPage.getWidth();