Color
Kind: class
- Color
- new Color(value, opacity)
- .a :
number - .r :
number - .g :
number - .b :
number - .toRgba() ⇒
!{r:number, g:number, b:number, a:number} - .toHex(forceSixDigits) ⇒
string - .clone() ⇒
!Color
new Color(value, opacity)
Create a new color instance.
| Param | Type | Description |
|---|---|---|
| value | ! string | number | {r:number, g:number, b:number, a:?number}` |
One of:
|
| opacity | ?number |
Optional, floating-point value from 0 - 1. Use when value parameter doesn't specify an opacity and you don't want the default 1.0 (100%) opacity. |
color.a : number
Integer 0-255. Get/set the alpha channel value.
Kind: instance property of Color
color.r : number
Integer 0-255. Get/set the red channel value.
Kind: instance property of Color
color.g : number
Integer 0-255. Get/set the green channel value.
Kind: instance property of Color
color.b : number
Integer 0-255. Get/set the blue channel value.
Kind: instance property of Color
color.toRgba()
Convert to an object with r, g, b, a keys where r, g, b, a range from 0 - 255.
Kind: instance method of Color
Returns: !{r:number, g:number, b:number, a:number}
color.toHex(forceSixDigits) ⇒ string
Convert to hex string with "#" prefix. Ignores the Color's alpha value. Returns a 3-digit string if possible, otherwise returns a 6-digit string.
Kind: instance method of Color
Returns: string - Hex color string in the form #123 or #456ABC.
| Param | Type | Description |
|---|---|---|
| forceSixDigits | boolean |
True if you want the result to always have 6 digits. |
color.clone() ⇒ !Color
Returns a clone of the current color object
