---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Ligne - Champ d'application, globale

# Ligne - Champ d'application, globale {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 minute de lecture

Crée un objet Ligne à l'aide de méthodes pour tracer une ligne dans un PDF.

Cette API fait partie du module d'extension ServiceNow PDF Generation Utilities (com.snc.apppdfgenerator) et est fournie dans l'espace de noms `sn_pdfgeneratorutils` . Le module d'extension est activé par défaut.

Cette API est un composant utilisé avec [l'API Document](https://servicenow-prod.fluidtopics.net/d3lN_FuuV~kguOiXJFlaSg#DocumentBothAPI "L’API Document fournit des méthodes pour initialiser un PDF, ajouter du contenu et fermer le PDF. Après avoir ajouté du contenu, le document peut être joint à un enregistrement cible.") pour générer un PDF.

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

Instancie un nouvel objet Ligne .
{#Line-Line__table_twm_hjk_34b__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 1. Paramètres]

{#Line-Line__table_twm_hjk_34b}  
Les exemples suivants montrent comment créer un objet Line .

    var line = new sn_pdfgeneratorutils.Line();

## Ligne -- drawLine(Document de document, numéro pageNo, numéro xPos, nombre yPos, largeur du nombre, largeur de ligne du numéro) {#ariaid-title3}

Place une ligne sur une page de document.
{#Line-drawLine_O_N_N_N_N_N__table_vv5_52h_44b__entry__3}

| Nom | Type | Description |
|-|-|-|
| Document | [Document](https://servicenow-prod.fluidtopics.net/d3lN_FuuV~kguOiXJFlaSg#DocumentBothAPI "L’API Document fournit des méthodes pour initialiser un PDF, ajouter du contenu et fermer le PDF. Après avoir ajouté du contenu, le document peut être joint à un enregistrement cible.") | Nom de l'objet du document. |
| pageNo | Numéro | Numéro de page sur lequel vous souhaitez placer la ligne. |
| xPos | Numéro | Zone de coordonnées X de la page sur laquelle placer la ligne. |
| yPos | Numéro | Zone de coordonnées Y de la page sur laquelle placer la ligne. |
| largeur | Numéro | Zone de largeur de la page dans laquelle vous souhaitez tracer la ligne. Les valeurs sont exprimées en points. |
| Largeur de ligne | Numéro | Facultatif. Valeur de l'épaisseur de ligne en points. Valeur par défaut : 1 |
[Tableau 2. Paramètres]

{#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}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 3. Renvoie]

{#Line-drawLine_O_N_N_N_N_N__table_wv5_52h_44b}  
L'exemple suivant montre comment créer une ligne dans la marge inférieure d'une page de document. Pour obtenir un exemple d'utilisation de document, consultez [API de document](https://servicenow-prod.fluidtopics.net/d3lN_FuuV~kguOiXJFlaSg#DocumentBothAPI "L’API Document fournit des méthodes pour initialiser un PDF, ajouter du contenu et fermer le PDF. Après avoir ajouté du contenu, le document peut être joint à un enregistrement cible.") .

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

## Ligne -- setColor(Couleur de couleur) {#ariaid-title4}

Définit la couleur d'une ligne.
{#Line-setColor_O__table_vv5_52h_44b__entry__3}

| Nom | Type | Description |
|-|-|-|
| couleur | [Couleur](https://servicenow-prod.fluidtopics.net/vSXsRPZbt54caAq_TLK9KA#ColorBothAPI "Crée un objet Couleur utilisé pour définir des attributs de couleur que vous pouvez appliquer aux éléments d’un PDF. tels que les cellules, les tableaux et les lignes.") | Couleur de la ligne. |
[Tableau 4. Paramètres]

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

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 5. Renvoie]

{#Line-setColor_O__table_wv5_52h_44b}  
L'exemple suivant montre comment créer une ligne et définir sa couleur dans un document. Pour obtenir un exemple d'utilisation de document, consultez [API de document](https://servicenow-prod.fluidtopics.net/d3lN_FuuV~kguOiXJFlaSg#DocumentBothAPI "L’API Document fournit des méthodes pour initialiser un PDF, ajouter du contenu et fermer le PDF. Après avoir ajouté du contenu, le document peut être joint à un enregistrement cible.") .

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