Cellule - Champ d’application, Global

Crée un objet Cell sous forme de cellule dans une table. Vous pouvez utiliser cette API pour formater la cellule et inclure des blocs supplémentaires, tels que des paragraphes et des images.

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 pour générer un PDF.

Cellule : cellule (nombre d’intervalle de lignes, nombre d’intervalles de lignes)

Instancie un nouvel objet Cell . Crée une cellule qui prend une quantité personnalisée d’espaces de cellule dans le tableau.

Remarque :

Si vous fournissez un nombre négatif pour l’un ou l’autre des paramètres, la valeur est définie sur 1.

Tableau 1. Paramètres

Nom	Type	Description
Parcours de ligne	Numéro	Nombre de lignes que cette cellule doit occuper. Par défaut : 0
colspan (en anglais seulement)	Numéro	Nombre de colonnes que cette cellule doit occuper. Par défaut : 0

L’exemple suivant montre comment créer un objet Cell couvrant une seule ligne et une seule colonne.

var cell = new sn_pdfgeneratorutils.Cell(1, 1);

Cellule – addImage(Image image)

Ajoute une image à une cellule de tableau.

Tableau 2. Paramètres

Nom	Type	Description
image	Image	Image à ajouter à une cellule de tableau.

Tableau 3. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment instancier une pièce jointe d’image existante et l’ajouter à une cellule d’un tableau. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 1);

var image = new Image("<attachment_sys_id>");

cell.addImage(image);

Cellule – addParagraph(Paragraphe paragraphe)

Ajoute du texte à une cellule de tableau.

Tableau 4. Paramètres

Nom	Type	Description
paragraphe	Paragraphe	Texte à ajouter à une cellule de tableau.

Tableau 5. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment instancier des objets de paragraphe et ajouter des cellules de contenu dans un tableau. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);
var para = new sn_pdfgeneratorutils.Paragraph("Paragraph text.");
cell.addParagraph(para);

Cellule – addStyle(Style style)

Applique un style prédéfini aux cellules d’un tableau.

Tableau 6. Paramètres

Nom	Type	Description
style	Style	Style à appliquer à cet élément.

Tableau 7. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment appliquer un style à une cellule de tableau. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);
var style = new sn_pdfgeneratorutils.Style();
style.setBold();
     
cell.addStyle(style);

Cellule : addTable(table de table)

Ajoute une table à une cellule.

Tableau 8. Paramètres

Nom	Type	Description
table	Table	Table à ajouter à une cellule.

Tableau 9. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment instancier un objet de table et l’ajouter à une cellule. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 1);

var columnWidths = [100, 50, 50];

var table = new Table(columnWidths, false);

cell.addTable(table);

Cellule : getColumn()

Obtient le numéro de la colonne dans laquelle se trouve la cellule.

Tableau 10. Paramètres

Nom	Type	Description
Aucun

Tableau 11. Renvoie

Type	Description
Numéro	Nombre de positions de colonne pour une cellule.

L’exemple suivant montre comment obtenir le numéro de la position d’une colonne pour une cellule.

var cell = new sn_pdfgeneratorutils.Cell(1, 1);

var columnWidths = [100, 50, 50];

var table = new sn_pdfgeneratorutils.Table(true, columnWidths, false);

table.addCell(cell);

var colNum = cell.getColumn();

gs.info("The column position for cell is " + colNum);

Sortie :

The column position for cell is 1

Cellule – getRow()

Obtient le nombre de lignes dans lesquelles se trouve la cellule.

Tableau 12. Paramètres

Nom	Type	Description
Aucun

Tableau 13. Renvoie

Type	Description
Numéro	Numéro de la position de ligne d’une cellule.

L’exemple suivant montre comment obtenir le numéro de la position d’une ligne pour une cellule.

var cell = new sn_pdfgeneratorutils.Cell(1, 1);

var rowWidths = [100, 50, 50];

var table = new sn_pdfgeneratorutils.Table(true, rowWidths, false);

table.addCell(cell);

var rowNum = cell.getRow();

gs.info("The row position for cell is " + rowNum);

Sortie :

The row position for cell is 4927

Cellule – setBackGroundColor(couleur de couleur)

Spécifie une couleur d’arrière-plan pour la cellule.

Tableau 14. Paramètres

Nom	Type	Description
couleur	Couleur	Couleur d’arrière-plan.

Tableau 15. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir la couleur d’arrière-plan d’une cellule. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var color = new sn_pdfgeneratorutils.Color([1, 0.9, 0.9]); // provided as array of RGB float values

cell.setBackGroundColor(color);

Cellule – setBorder(largeur du nombre)

Définit une bordure pour les quatre bordures d’une cellule.

Tableau 16. Paramètres

Nom	Type	Description
largeur	Numéro	Largeur de bordure de cellule en points.

Tableau 17. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir la bordure d’une cellule d’un point sur les quatre bords d’une cellule. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var width = 1.0;

cell.setBorder(width);

Cellule – setBorderBottom(largeur du nombre)

Définit une bordure pour la limite inférieure d’une cellule.

Tableau 18. Paramètres

Nom	Type	Description
largeur	Numéro	Largeur de bordure de cellule en points.

Tableau 19. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une bordure de cellule. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var width = 1.0;

cell.setBorder(width);

Cellule – setBorderLeft(largeur numérique)

Définit une bordure pour la limite gauche d’une cellule.

Tableau 20. Paramètres

Nom	Type	Description
largeur	Numéro	Largeur de bordure de cellule en points.

Tableau 21. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une bordure de cellule à gauche. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var width = 1.0;

cell.setLeftBorder(width);

Cellule – setBorderRight(largeur du nombre)

Définit une bordure pour la limite droite d’une cellule.

Tableau 22. Paramètres

Nom	Type	Description
largeur	Numéro	Largeur de bordure de cellule en points.

Tableau 23. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une bordure de cellule à droite. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var width = 1.0;

cell.setRightBorder(width);

Cellule – setBorderTop(largeur du nombre)

Définit une bordure pour la limite supérieure d’une cellule.

Tableau 24. Paramètres

Nom	Type	Description
largeur	Numéro	Largeur de bordure de cellule en points.

Tableau 25. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une bordure de cellule supérieure. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var width = 1.0;

cell.setBorderTop(width);

Cellule – setColoredBorder(couleur de couleur, largeur numérique)

Définit une bordure colorée pour les quatre bords d’une cellule.

Tableau 26. Paramètres

Nom	Type	Description
couleur	Couleur	Couleur de la bordure de la cellule.
largeur	Numéro	Largeur de bordure de cellule en points.

Tableau 27. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une bordure de cellule colorée. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var borderColor = new sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);
var width = 1.0;

cell.setColoredBorder(borderColor, width);

Cellule – setColoredBorderBottom(couleur de couleur, largeur numérique)

Définit une bordure colorée pour la limite inférieure d’une cellule.

Tableau 28. Paramètres

Nom	Type	Description
couleur	Couleur	Couleur de la bordure de la cellule.
largeur	Numéro	Largeur de bordure de cellule en points.

Tableau 29. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une bordure de cellule inférieure colorée. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var borderColor = new sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);
var width = 1.0;

cell.setColoredBorderBottom(borderColor, width);

Cellule – setColoredBorderLeft(couleur de couleur, largeur numérique)

Définit une bordure colorée pour la limite gauche d’une cellule.

Tableau 30. Paramètres

Nom	Type	Description
couleur	Couleur	Couleur de la bordure de la cellule.
largeur	Numéro	Largeur de bordure de cellule en points.

Tableau 31. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une bordure de cellule gauche colorée. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var borderColor = new sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);
var width = 1.0;

cell.setColoredBorderLeft(borderColor, width);

Cellule – setColoredBorderRight(couleur de couleur, largeur numérique)

Définit une bordure colorée pour la limite droite d’une cellule.

Tableau 32. Paramètres

Nom	Type	Description
couleur	Couleur	Couleur de la bordure de la cellule.
largeur	Numéro	Largeur de bordure de cellule en points.

Tableau 33. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une bordure de cellule colorée à droite. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var borderColor = new sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);
var width = 1.0;

cell.setColoredBorderRight(borderColor, width);

Cellule – setColoredBorderTop(couleur de couleur, largeur numérique)

Définit une bordure colorée pour la limite supérieure d’une cellule.

Tableau 34. Paramètres

Nom	Type	Description
couleur	Couleur	Couleur de la bordure de la cellule.
largeur	Numéro	Largeur de bordure de cellule en points.

Tableau 35. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une bordure de cellule supérieure colorée. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var borderColor = new sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);
var width = 1.0;

cell.setColoredBorderTop(borderColor, width);

Cellule – setHeight(Number height)

Définit la hauteur d’une cellule.

Tableau 36. Paramètres

Nom	Type	Description
valide	Numéro	Hauteur de cellule en points.

Tableau 37. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une hauteur de cellule de 10 points. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var height = 10;

cell.setHeight(height);

Cellule – setHorizontalAlignment(Alignement de chaînes)

Définit l’alignement horizontal de cette cellule.

Tableau 38. Paramètres

Nom	Type	Description
alignement	Chaîne	Réglage de l’alignement horizontal. Valeurs valides : center : permet d’aligner le contenu sur le centre. left : Alignez le contenu vers la gauche. droite : alignez le contenu vers la droite.

Tableau 39. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir l’alignement horizontal sur une cellule. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var alignment = "center";

cell.setHorizontalAlignment(alignment);

Cellule – setMaxHeight(valeur numérique)

Définit la hauteur maximale d’une cellule.

Tableau 40. Paramètres

Nom	Type	Description
valide	Numéro	Hauteur maximale de cellule en points.

Tableau 41. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une hauteur de cellule maximale de 409 points. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var height = 409;

cell.setMaxHeight(height);

Cellule : setMaxWidth(valeur flottante)

Définit la largeur maximale d’une cellule.

Tableau 42. Paramètres

Nom	Type	Description
valide	Numéro	Largeur maximale de cellule en points.

Tableau 43. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une largeur de cellule maximale de 1 530 points. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var width = 1530;

cell.setMaxWidth(width);

Cellule : setMinHeight(valeur numérique)

Définit la hauteur minimale d’une cellule.

Tableau 44. Paramètres

Nom	Type	Description
valide	Numéro	Hauteur minimale de cellule en points.

Tableau 45. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une hauteur de cellule minimale de 12,75 points. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var height = 12.75;

cell.setMinHeight(height);

Cellule : setMinWidth(valeur numérique)

Définit la largeur minimale d’une cellule.

Tableau 46. Paramètres

Nom	Type	Description
valide	Numéro	Largeur minimale de cellule en points.

Tableau 47. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une largeur de cellule minimale de 50,58 points. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var width = 50.58;

cell.setMinWidth(width);

Cellule – setOpacity(Opacité du nombre)

Définit l’opacité du contenu, des bordures et de l’arrière-plan des cellules.

Remarque :

Ce paramètre affecte tous les éléments enfants de la cellule.

Tableau 48. Paramètres

Nom	Type	Description
opacité	Numéro	Valeur décimale flottante comprise entre 0 et 1, dans laquelle 0 est transparent et 1 est totalement opaque. Par défaut : 0

Tableau 49. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir l’opacité d’une cellule.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var opacity = 0.5;

cell.setOpacity(opacity);

Cellule – setPadding(Remplissage du nombre)

Définit le remplissage des quatre côtés d’une cellule à la même largeur.

Voir aussi :

• setPaddingBottom()
• setPaddingLeft()
• setPaddingRight()
• setPaddingTop()

Tableau 50. Paramètres

Nom	Type	Description
Marge intérieure	Numéro	Largeur de remplissage en points sous forme de valeur décimale.

Tableau 51. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir la cellule inférieure sur un point. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var padding = 1.0;

cell.setPadding(padding);

Cellule – setPaddingBottom(remplissage du nombre)

Définit la valeur de la largeur du remplissage inférieur d’une cellule.

Voir aussi :

• setPadding()
• setPaddingLeft()
• setPaddingRight()
• setPaddingTop()

Tableau 52. Paramètres

Nom	Type	Description
Marge intérieure	Numéro	Largeur de remplissage en points sous forme de valeur décimale.

Tableau 53. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir le remplissage de la cellule inférieure sur un point. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var padding = 1.0;

cell.setPaddingBottom(padding);

Cellule : setPaddingLeft(remplissage des numéros)

Définit la valeur de la largeur du remplissage gauche d’une cellule.

Voir aussi :

• setPadding()
• setPaddingBottom()
• setPaddingRight()
• setPaddingTop()

Tableau 54. Paramètres

Nom	Type	Description
Marge intérieure	Numéro	Largeur de remplissage en points sous forme de valeur décimale.

Tableau 55. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir le remplissage de la cellule gauche sur un point. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var padding = 1.0;

cell.setPaddingLeft(padding);

Cellule – setPaddingRight(remplissage du numéro)

Définit la valeur de la largeur du remplissage droit d’une cellule.

Voir aussi :

• setPadding()
• setPaddingBottom()
• setPaddingLeft()
• setPaddingTop()

Tableau 56. Paramètres

Nom	Type	Description
Marge intérieure	Numéro	Largeur de remplissage en points sous forme de valeur décimale.

Tableau 57. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir le remplissage d’une cellule droite en un point. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var padding = 1.0;

cell.setPaddingRight(padding);

Cellule – setPaddingTop(Remplissage du numéro)

Définit la valeur de la largeur du remplissage supérieur d’une cellule.

Voir aussi :

• setPadding()
• setPaddingBottom()
• setPaddingLeft()
• setPaddingRight()

Tableau 58. Paramètres

Nom	Type	Description
Marge intérieure	Numéro	Largeur de remplissage en points sous forme de valeur décimale.

Tableau 59. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir le remplissage d’une cellule supérieure en un point. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var padding = 1.0;

cell.setPaddingTop(padding);

Cellule – setTextAlignment(Alignement de chaînes)

Définit l’alignement du texte de cette cellule.

Tableau 60. Paramètres

Nom	Type	Description
alignement	Chaîne	Position d’alignement du texte. Valeurs valides : text-center : aligne le texte au centre. text-justified : modifie l’espace entre les caractères pour remplir complètement le texte entre les côtés gauche et droit. La dernière ligne est alignée à gauche. text-justified-all : justifie l’alignement du texte, y compris la dernière ligne. text-left : Aligner le texte vers la gauche. text-right : Aligner le texte à droite.

Tableau 61. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir le texte de la cellule sur l’alignement à gauche.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var alignment = "text-left";

cell.setTextAlignment(alignment);

Cellule – setVerticalAlignment(Alignement de chaînes)

Définit l’alignement vertical de cette cellule.

Tableau 62. Paramètres

Nom	Type	Description
alignement	Chaîne	Réglage de l’alignement vertical. Valeurs valides : bottom : aligne le contenu vers le bas. mid : aligne le contenu sur le centre. top : aligne le contenu sur le haut.

Tableau 63. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir l’alignement vertical sur une cellule. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var alignment = "mid";

cell.setVerticalAlignment(alignment);