Table des matières
Color [En cours de Traduction Wismerheal][WSL]
Cet objet représente la couleur.
Functions
Color
Fonction de construction.
Syntaxe
var myObject = new Color();
var myObject = new Color(colorName);
var myObject = new Color(otherColor);
var myObject = new Color(red, green, blue);
var myObject = new Color(red, green, blue, alpha);
Arguments
- colorName - (string) nom de la Couleur
- otherColor - (Color) autre Couleur à copier
- red - (integer) valeur du rouge (0-255)
- green - (integer) valeur du vert (0-255)
- blue - (integer) valeur du bleu (0-255)
- alpha - (integer) valeur de l'alpha (transparence) (0-255)
Exceptions
- (ColorNameError) nom de couleur incorrect
- (ParameterTypeError) type de paramètre incorrect
- (ParameterCountError) paramètre de compteur incorrect
Example
Créer la Couleur noire.
var myObject = new Color();
Créer une Couleur nommée. Voir http://www.w3.org/TR/SVG/types.html#ColorKeywords pour la liste complète.
var myObject = new Color("red");
Créer une couleur à partir d'une valeur hexadecimal.
var myObject = new Color("#FE5");
var myObject = new Color("#FF5577");
Créer une Couleur représentant une copie de otherColor.(autreCouleur)
var myObject = new Color(otherColor);
Créer la Couleur grise.
var myObject = new Color(50, 50, 50);
Créer une Couleur grise semi-transparente.
var myObject = new Color(50, 50, 50, 128);
Méthodes
clone
Renvoie une copie de cette Couleur.
Syntaxe
myObject.clone();
Renvoie
- (Color) une copie de cette Couleur
Example
var copyOfMyObject = myObject.clone();
equals
Renvoie vrai si cette Couleur ou autres font références à la même couleur. Returns true if this Color and another are referencing the same color.
Syntaxe
myObject.equals(other);
Arguments
- other - (Color) une autre Couleur
Returns
- (bool) vrai si other fait référence à la même couleur
Example
if(myFirstObject.equals(mySecondObject)) //Do something
toString
Renvoie une chaîne représentant la Couleur.
Syntaxe
myObject.toString();
Renvoie
- (chaîne) une chaîne représentant la Couleur
Example
Console.print(myObject.toString());
Notes
Cette méthodes est automatiquement appelée quand on tente de convertir une Couleur en chaîne.
setRed
Définit le composant rouge de cette Couleur.
Syntaxe
myObject.setRed(red);
Renvoie
- (Color) la Couleur
Example
myObject.setRed(128);
setGreen
Définit le composant verte cette Couleur.
Syntaxe
myObject.setGreen(green);
Renvoie
- (Color) la Couleur
Example
myObject.setGreen(128);
setBlue
Définit le composant bleu de cette Couleur.
Syntaxe
myObject.setBlue(blue);
Renvoie
- (Color) la Couleur
Example
myObject.setBlue(128);
setAlpha
Définit le composant alpha (transparence) de cette Couleur.
Syntaxe
myObject.setAlpha(alpha);
Renvoie
- (Color) la Coueleur
Example
myObject.setAlpha(128);
setCmyk
Définit la valeur CMYK de cette Couleur. (Cyan; Magenta; Jaune; Noir)
Syntaxe
myObject.setCmyk(cyan, magenta, yellow, black);
myObject.setCmyk(cyan, magenta, yellow, black, alpha);
Renvoie
- (Color) la Couleur
Example
myObject.setCmyk(128, 60, 60, 100);
myObject.setCmyk(128, 60, 60, 128);
setHsl
Définit la valeur HSL de cette Couleur. (Teinte ; Saturation ; Luminance)
Syntaxe
myObject.setHsl(hue, saturation, lightness);
myObject.setHsl(hue, saturation, lightness, alpha);
Renvoie
- (Color) la Couleur
Example
myObject.setHsl(50, 100, 100);
myObject.setHsl(50, 100, 100, 128);
setHsv
Définit cette Couleur en valeur HSV.
Syntaxe
myObject.setHsv(hue, saturation, value);
myObject.setHsv(hue, saturation, value, alpha);
Renvoie
- (Color) la Couleur
Example
myObject.setHsv(25, 50, 150);
myObject.setHsv(25, 50, 150, 100);
setNamedColor
Définit la Couleur en une valeur nommée.
Syntaxe
myObject.setNamedColor(name);
Renvoie
- (Color) la Couleur
Exceptions
- (ColorNameError) nom de couleur incorrect
Example
Définit une couleur nommée. Voir http://www.w3.org/TR/SVG/types.html#ColorKeywords pour la liste complète.
myObject.setNamedColor("red");
Définit une couleur à partir d'une valeur hexadecimal.
myObject.setNamedColor("#FE5");
myObject.setNamedColor("#FF5577");
lighten
Facteur de luminance d'une couleur .
Syntaxe
Luminance à 50%.
myObject.lighten();
Ligthen by a factor. (percent)
myObject.lighten(factor);
Renvoie
- (Color) La Couleur
Example
myObject.lighten();
myObject.lighten(175); //Lighten by 75%
darken
Facteur d'assombrissement d'une couleur.
Syntaxe
Assombrir à 50%.
myObject.darken();
Darken by a factor. (percent)
myObject.darken(factor);
Renvoie
- (Color) la Couleur
Example
myObject.darken();
myObject.darken(175); //Darken by 75%
red
Renvoie le composant rouge de la Couleur.
Syntaxe
myObject.red();
Renvoie
- (int) la valeur du composant rouge de la Couleur(0-255)
Example
var myValue = myObject.red();
[TODO:Translate]
green
Returns the green component of this Color.
Syntax
myObject.green();
Returns
- (int) the green component value (0-255)
Example
var myValue = myObject.green();
blue
Renvoie le composant bleu de la Couleur.
Syntaxe
myObject.blue();
Renvoie
- (int) la valeur du composant bleu de la Couleur(0-255)
Example
var myValue = myObject.blue();
alpha
Renvoie le composant alpha de la Couleur.
Syntaxe
myObject.alpha();
Renvoie
- (int) la valeur du composant alpha de la Couleur(0-255)
Example
var myValue = myObject.alpha();
cyan
Renvoie le composant cyan de la Couleur.
Syntaxe
myObject.cyan();
Renvoie
- (int) la valeur du composant cyan de la Couleur(0-255)
Example
var myValue = myObject.cyan();
magenta
Renvoie le composant magenta de la Couleur.
Syntaxe
myObject.magenta();
Renvoie
- (int) la valeur du composant magenta de la Couleur(0-255)
Example
var myValue = myObject.magenta();
yellow
Renvoie le composant jaune de la Couleur.
Syntaxe
myObject.yellow();
Renvoie
- (int) la valeur du composant jaune de la Couleur(0-255)
Example
var myValue = myObject.yellow();
black
Renvoie le composant noir de la Couleur.
Syntaxe
myObject.black();
Renvoie
- (int) la valeur du composant noir de la Couleur(0-255)
Example
var myValue = myObject.black();
hue
Renvoie le composant teinte de la Couleur.
Syntaxe
myObject.hue();
Renvoie
- (int)la valeur du composant teinte de la Couleur(0-255)
Example
var myValue = myObject.hue();
saturation
Renvoie le composant saturation de la Couleur.
Syntaxe
myObject.saturation();
Renvoie
- (int) la valeur du composant saturation de la Couleur(0-255)
Example
var myValue = myObject.saturation();
lightness
Renvoie le composant luminance de la Couleur.
Syntaxe
myObject.lightness();
Renvoie
- (int) la valeur du composant luminance de la Couleur(0-255)
Example
var myValue = myObject.lightness();
name
Renvoie le nom de la Couleur au format "#RRGGBB".
Syntaxe
myObject.name();
Renvoie
- (int) le nom de la Couleur au format "#RRGGBB"
Example
var myValue = myObject.name();
Attributes
red
Le composant rouge de cette Couleur. (entier)
Example
myObject.red = 50; Console.print(myObject.red);
green
Le composant vert de cette Couleur. (entier)
Example
myObject.green = 50; Console.print(myObject.green);
blue
Le composant bleu de cette Couleur. (entier)
Example
myObject.blue = 50; Console.print(myObject.blue);
alpha
Le composant alpha de cette Couleur. (entier)
Example
myObject.alpha = 50; Console.print(myObject.alpha);