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


---

# Linha - com escopo, global

# Linha - 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) 1 min. de leitura

Cria um objeto de linha usando métodos para desenhar uma linha em um PDF.

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.

## Linha - Linha () {#ariaid-title2}

Instancia um novo objeto de linha.
{#Line-Line__table_twm_hjk_34b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum(a) |   |   |
[Tabela 1. Parâmetros]

{#Line-Line__table_twm_hjk_34b}  
Os exemplos a seguir mostram como criar um objeto de linha.

    var line = new sn_pdfgeneratorutils.Line();

## Linha -- pullLine(Document document, Number pageNo, Number xPos, Number yPos, Number Width, Number lineWidth) {#ariaid-title3}

Insere uma linha em uma página do documento.
{#Line-drawLine_O_N_N_N_N_N__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Documento | [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.") | Nome do objeto de documento. |
| pageNo | Número | Número da página na qual você deseja colocar a linha. |
| xPos | Número | Área da coordenada X da página na qual a linha será colocada. |
| yPos | Número | Área da coordenada Y da página na qual a linha será colocada. |
| largura | Número | Área de largura da página na qual você deseja desenhar a linha. Os valores estão em pontos. |
| largura da linha | Número | Opcional. Valor da espessura da linha em pontos. Padrão: 1 |
[Tabela 2. Parâmetros]

{#Line-drawLine_O_N_N_N_N_N__table_vv5_52h_44b} {#Line-drawLine_O_N_N_N_N_N__table_wv5_52h_44b__entry__2}

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

{#Line-drawLine_O_N_N_N_N_N__table_wv5_52h_44b}  
O exemplo a seguir mostra como criar uma linha na margem inferior de uma página do documento. Para obter um exemplo de uso de documento, consulte [Document](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.") API.

    var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
    var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);

    var num = 1;
    var xpos = 100;
    var ypos = 100;
    var width = 450;
    var linewidth = 2.5;

    document.addNewPage();

    var line = new sn_pdfgeneratorutils.Line();

    line.drawLine(document, num, xpos, ypos, width, linewidth);

    document.saveAsAttachment("incident", "<sys_id>", "line.pdf");

## Linha -- setColor(Cor) {#ariaid-title4}

Define a cor de uma linha.
{#Line-setColor_O__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 linha. |
[Tabela 4. Parâmetros]

{#Line-setColor_O__table_vv5_52h_44b} {#Line-setColor_O__table_wv5_52h_44b__entry__2}

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

{#Line-setColor_O__table_wv5_52h_44b}  
O exemplo a seguir mostra como criar uma linha e definir sua cor em um documento. Para obter um exemplo de uso de documento, consulte [Document](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.") API.

    var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
    var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);

    var num = 1;
    var xpos = 100;
    var ypos = 100;
    var width = 450;
    var linewidth = 2.5;

    var color = new sn_pdfgeneratorutils.Color([0.5,0.5,0.8]);   //given as array of RGB values;

    document.addNewPage();

    var line = new sn_pdfgeneratorutils.Line();

    line.setColor(color);

    line.drawLine(document, num, xpos, ypos, width, linewidth);

    document.saveAsAttachment("incident", "<sys_id>", "lineWithColor.pdf");