Couleur - Champ d’application, Global

Crée un objet Color utilisé pour définir les attributs de couleur que vous pouvez appliquer aux éléments d’un PDF ; tels que les cellules, les tableaux et les lignes.

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.

Couleur : couleur (tableau de couleurs)

Instancie un nouvel objet Color avec des valeurs RVB.

La couleur peut être appliquée aux scénarios suivants :

Tableau 1. Paramètres

Nom	Type	Description
colors	Tableau	Trois nombres indiquant les valeurs RVB à l’aide d’une valeur décimale comprise entre 0 et 1. Par exemple, dans [0.1, 0.9, 0.5], la valeur de la première position est rouge, la deuxième est verte et la troisième est bleue. De plus, [0, 0, 0] est noir uni, [0,5, 0,5, 0,5] est gris uni et [1, 1, 1] est blanc uni.

L’exemple suivant montre comment créer un objet Color .

var color = new sn_pdfgeneratorutils.Color([0.1, 0.9, 0.5]); //given as object containing RGB values

Couleur – est égal à (couleur de couleur)

Indique si les valeurs de deux objets de couleur différente correspondent.

Tableau 2. Paramètres

Nom	Type	Description
couleur	Couleur	Objet de couleur pour vérifier la correspondance.

Tableau 3. Renvoie

Type	Description
Booléen	Marqueur indiquant si les valeurs de deux objets de couleur correspondent. Valeurs valides : true : les couleurs correspondent. false : les couleurs ne correspondent pas.

L’exemple suivant montre comment créer deux objets de couleur et déterminer si les couleurs correspondent.

var color1 = new sn_pdfgeneratorutils.Color([1,0.5,0.5]);  // given as an array of RGB values
var color2 = new sn_pdfgeneratorutils.Color([0.8,0.5,0.5]);         // given as an array of RGB values
var isequal = color1.equals(color2);

Couleur – getGrayColor(Number grayScale)

Renvoie un objet de couleur noire, grise ou blanche.

Tableau 4. Paramètres

Nom	Type	Description
Gris	Numéro	Valeur décimale comprise entre 0 et 1, dans laquelle 0 est noir et 1 est blanc.

Tableau 5. Renvoie

Type	Description
Objet	Objet de couleur reflétant la valeur de niveaux de gris fournie.

L’exemple suivant montre comment créer un objet couleur composé de 50 % de niveaux de gris.

var grayColor = new sn_pdfgeneratorutils.Color.getGrayColor(0.5);

Couleur – setColorValue(Array colors)

Crée une couleur avec des valeurs données et vous permet de modifier les valeurs d’une couleur existante. Chacune des valeurs doit être comprise entre 0 et 1.

Tableau 6. Paramètres

Nom	Type	Description
colors	Tableau	Trois nombres indiquant les valeurs RVB à l’aide d’une valeur décimale comprise entre 0 et 1. Par exemple, dans [0.1, 0.9, 0.5], la valeur de la première position est rouge, la deuxième est verte et la troisième est bleue. De plus, [0, 0, 0] est noir uni, [0,5, 0,5, 0,5] est gris uni et [1, 1, 1] est blanc uni.

Tableau 7. Renvoie

Type	Description
Néant

L’exemple suivant montre comment modifier les valeurs d’une couleur existante.

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

Couleur – setOpacity(Number opacity)

Définit le niveau d’opacité de la couleur.

Tableau 8. Paramètres

Nom	Type	Description
couleur	Couleur	Valeur décimale flottante comprise entre 0 et 1, dans laquelle 0 est entièrement transparent et 1 est entièrement opaque.

Tableau 9. Renvoie

Type	Description
Néant

L’exemple suivant montre comment créer un objet de couleur et définir son opacité sur 50 pour cent.

var color = new Color([1,0.5,0.5]);
color.setOpacity(0.5);