Color

Extends Object.

Instantiation

You can instantiate a new Color object by supplying a hexadecimal value, or a string:

<?ev
    // new Color() using hexadecimal
    var red = new Color('#ff0000');
    
    // new Color() using a string
    var red = new Color('red');
?>

Construct parameters
color

String

If the color supplied is a valid hexadecimal value, the Color object will return the hexadecimal value.

<?ev
    var red = new Color('#ff0000'); // #FF0000;
    var red = new Color('#f00'); // #FF0000;
?>

If the color supplied is not a valid hexadecimal value, but is a known color, the Color object will return the long hexadecimal value.
You can find a list of known colors here.

<?ev
    var red = new Color('red'); // #FF0000;
    var yellow = new Color('yellow'); // #FFFF00;
?>

If the color supplied is not a valid hexadecimal value, nor is it a known color, the Color object will generate and return a hexadecimal value.

<?ev
    var evance = new Color('evance'); // #2DB2F1
?>


Methods
darken([Number:amount])

Returns Color

The amount parameter is optional and will default to 10.

Decrease the light value (100% to 0%) of your color by the amount provided, a new color object with the new hexadecimal value will be returned.

<?ev
    var red = new Color('red');
    echo(red.darken()); // #CC0000
    echo(red.darken(20)); // #990000
?>
hex()

Returns String

Returns the hexadecimal value as a string with the '#' prefix.

isDark([Number:threshold])

Returns Boolean

The threshold parameter is optional and will default to 130.

If your color's light value (0 to 255) is less than or equal to the threshold, the method will return true.

<?ev
    var red = new Color('red');
    echo(red.isDark()); // true
    echo(red.isDark(50)); // false
?>
isLight([Number:threshold])

Returns Boolean

The threshold parameter is optional and will default to 130.

If your color's light value (0 to 255) is greater than the threshold, the method will return true.

<?ev
    var red = new Color('red');
    echo(red.isLight()); // false
    echo(red.isLight(50)); // true
?>
lighten([Number:amount])

Returns Color

The amount parameter is optional and will default to 10.

Increase the light value (0% to 100%) of your color by the amount provided, a new color object with the new hexadecimal value will be returned.

<?ev
    var red = new Color('red');
    echo(red.lighten()); // #FF3333
    echo(red.lighten(20)); // #FF6666
?>
opacity([Number:amount])

Returns Color

Set the opacity value of your color from 0 (transparent) to 100 (opaque), a new color object with the new rgba value will be returned

<?ev
    var red = new Color('red');
    echo(red.opacity(70)); // rgba(255, 0, 0, 0.7)
?>
rgb()

Returns Array

Returns the red, green and blue values of your color in an array.

rgba()

Returns Array

Returns the red, green, blue and alpha values of your color in an array.

toString()

Returns String

If an opacity has been applied to the color, this method returns the rgba as a comma-seperated string, wrapped within "rgba()".

Otherwise, this method returns the hexadecimal value as a string.

<?ev
    var red = new Color('red');
    echo(red.toString()); // #ff0000
    echo(red.opacity(70).toString()); // rgba(255, 0, 0, 0.7)
?>


Known Colors
aliceblue

#F0F8FF

antiquewhite

#FAEBD7

aqua

#00FFFF

aquamarine

#7FFFD4

azure

#F0FFFF

beige

#F5F5DC

bisque

#FFE4C4

black

#000000

blanchedalmond

#FFEBCD

blue

#0000FF

blueviolet

#8A2BE2

brown

#A52A2A

burlywood

#DEB887

cadetblue

#5F9EA0

chartreuse

#7FFF00

chocolate

#D2691E

coral

#FF7F50

cornflowerblue

#6495ED

cornsilk

#FFF8DC

crimson

#DC143C

cyan

#00FFFF

darkblue

#00008B

darkcyan

#008B8B

darkgoldenrod

#B8860B

darkgray

#A9A9A9

darkgrey

#A9A9A9

darkgreen

#006400

darkkhaki

#BDB76B

darkmagenta

#8B008B

darkolivegreen

#556B2F

darkorange

#FF8C00

darkorchid

#9932CC

darkred

#8B0000

darksalmon

#E9967A

darkseagreen

#8FBC8F

darkslateblue

#483D8B

darkslategray

#2F4F4F

darkslategrey

#2F4F4F

darkturquoise

#00CED1

darkviolet

#9400D3

deeppink

#FF1493

deepskyblue

#00BFFF

dimgray

#696969

dimgrey

#696969

dodgerblue

#1E90FF

firebrick

#B22222

floralwhite

#FFFAF0

forestgreen

#228B22

fuchsia

#FF00FF

gainsboro

#DCDCDC

ghostwhite

#F8F8FF

gold

#FFD700

goldenrod

#DAA520

gray

#808080

grey

#808080

green

#008000

greenyellow

#ADFF2F

honeydew

#F0FFF0

hotpink

#FF69B4

indianred

#CD5C5C

indigo

#4B0082

ivory

#FFFFF0

khaki

#F0E68C

lavender

#E6E6FA

lavenderblush

#FFF0F5

lawngreen

#7CFC00

lemonchiffon

#FFFACD

lightblue

#ADD8E6

lightcoral

#F08080

lightcyan

#E0FFFF

lightgoldenrodyellow

#FAFAD2

lightgray

#D3D3D3

lightgrey

#D3D3D3

lightgreen

#90EE90

lightpink

#FFB6C1

lightsalmon

#FFA07A

lightseagreen

#20B2AA

lightskyblue

#87CEFA

lightslategray

#778899

lightslategrey

#778899

lightsteelblue

#B0C4DE

lightyellow

#FFFFE0

lime

#00FF00

limegreen

#32CD32

linen

#FAF0E6

magenta

#FF00FF

maroon

#800000

mediumaquamarine

#66CDAA

mediumblue

#0000CD

mediumorchid

#BA55D3

mediumpurple

#9370D8

mediumseagreen

#3CB371

mediumslateblue

#7B68EE

mediumspringgreen

#00FA9A

mediumturquoise

#48D1CC

mediumvioletred

#C71585

midnightblue

#191970

mintcream

#F5FFFA

mistyrose

#FFE4E1

moccasin

#FFE4B5

navajowhite

#FFDEAD

navy

#000080

oldlace

#FDF5E6

olive

#808000

olivedrab

#6B8E23

orange

#FFA500

orangered

#FF4500

orchid

#DA70D6

palegoldenrod

#EEE8AA

palegreen

#98FB98

paleturquoise

#AFEEEE

palevioletred

#D87093

papayawhip

#FFEFD5

peachpuff

#FFDAB9

peru

#CD853F

pink

#FFC0CB

plum

#DDA0DD

powderblue

#B0E0E6

purple

#800080

red

#FF0000

rosybrown

#BC8F8F

royalblue

#4169E1

saddlebrown

#8B4513

salmon

#FA8072

sandybrown

#F4A460

seagreen

#2E8B57

seashell

#FFF5EE

sienna

#A0522D

silver

#C0C0C0

skyblue

#87CEEB

slateblue

#6A5ACD

slategray

#708090

slategrey

#708090

snow

#FFFAFA

springgreen

#00FF7F

steelblue

#4682B4

tan

#D2B48C

teal

#008080

thistle

#D8BFD8

tomato

#FF6347

turquoise

#40E0D0

violet

#EE82EE

wheat

#F5DEB3

white

#FFFFFF

whitesmoke

#F5F5F5

yellow

#FFFF00

yellowgreen

#9ACD32