View source for Color parameters

''New to [[Analytica 5.0]]''

Several built-in functions include parameters that expect a color, and you might want to create your own [[User-defined functions]] that expect colors as well. A color parameter is tagged with the [[Function parameter qualifiers#Color|Color qualifier]] in the function's parameter declaration. The caller can provide either a textual name of a color or a color integer.

== Color names ==

When specifying a color by name, a textual name is provided. For example, <code>[[CellFill]]('Green')</code>. The following table shows the color names that are recognized.

<table border="1">
<tr><td>&nbsp;'''Name'''</td><td>'''&nbsp;Color'''&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td></tr>
<tr><td>AliceBlue</td><td style="background-color:#F0F8FF">&nbsp;</td></tr>
<tr><td>AntiqueWhite</td><td style="background-color:#FAEBD7">&nbsp;</td></tr>
<tr><td>Aqua</td><td style="background-color:#00FFFF">&nbsp;</td></tr>
<tr><td>Aquamarine</td><td style="background-color:#7FFFD4">&nbsp;</td></tr>
<tr><td>Azure</td><td style="background-color:#F0FFFF">&nbsp;</td></tr>
<tr><td>Beige</td><td style="background-color:#F5F5DC">&nbsp;</td></tr>
<tr><td>Bisque</td><td style="background-color:#FFE4C4">&nbsp;</td></tr>
<tr><td>Black</td><td style="background-color:#000000">&nbsp;</td></tr>
<tr><td>BlanchedAlmond</td><td style="background-color:#FFEBCD">&nbsp;</td></tr>
<tr><td>Blue</td><td style="background-color:#0000FF">&nbsp;</td></tr>
<tr><td>BlueViolet</td><td style="background-color:#8A2BE2">&nbsp;</td></tr>
<tr><td>Brown</td><td style="background-color:#A52A2A">&nbsp;</td></tr>
<tr><td>BurlyWood</td><td style="background-color:#DEB887">&nbsp;</td></tr>
<tr><td>CadetBlue</td><td style="background-color:#5F9EA0">&nbsp;</td></tr>
<tr><td>Chartreuse</td><td style="background-color:#7FFF00">&nbsp;</td></tr>
<tr><td>Chocolate</td><td style="background-color:#D2691E">&nbsp;</td></tr>
<tr><td>Coral</td><td style="background-color:#FF7F50">&nbsp;</td></tr>
<tr><td>CornflowerBlue</td><td style="background-color:#6495ED">&nbsp;</td></tr>
<tr><td>Cornsilk</td><td style="background-color:#FFF8DC">&nbsp;</td></tr>
<tr><td>Crimson</td><td style="background-color:#DC143C">&nbsp;</td></tr>
<tr><td>Cyan</td><td style="background-color:#00FFFF">&nbsp;</td></tr>
<tr><td>DarkBlue</td><td style="background-color:#00008B">&nbsp;</td></tr>
<tr><td>DarkCyan</td><td style="background-color:#008B8B">&nbsp;</td></tr>
<tr><td>DarkGoldenrod</td><td style="background-color:#B8860B">&nbsp;</td></tr>
<tr><td>DarkGray</td><td style="background-color:#A9A9A9">&nbsp;</td></tr>
<tr><td>DarkGreen</td><td style="background-color:#006400">&nbsp;</td></tr>
<tr><td>DarkKhaki</td><td style="background-color:#BDB76B">&nbsp;</td></tr>
<tr><td>DarkMagenta</td><td style="background-color:#8B008B">&nbsp;</td></tr>
<tr><td>DarkOliveGreen</td><td style="background-color:#556B2F">&nbsp;</td></tr>
<tr><td>DarkOrange</td><td style="background-color:#FF8C00">&nbsp;</td></tr>
<tr><td>DarkOrchid</td><td style="background-color:#9932CC">&nbsp;</td></tr>
<tr><td>DarkRed</td><td style="background-color:#8B0000">&nbsp;</td></tr>
<tr><td>DarkSalmon</td><td style="background-color:#E9967A">&nbsp;</td></tr>
<tr><td>DarkSeaGreen</td><td style="background-color:#8FBC8B">&nbsp;</td></tr>
<tr><td>DarkSlateBlue</td><td style="background-color:#483D8B">&nbsp;</td></tr>
<tr><td>DarkSlateGray</td><td style="background-color:#2F4F4F">&nbsp;</td></tr>
<tr><td>DarkTurquoise</td><td style="background-color:#00CED1">&nbsp;</td></tr>
<tr><td>DarkViolet</td><td style="background-color:#9400D3">&nbsp;</td></tr>
<tr><td>DeepPink</td><td style="background-color:#FF1493">&nbsp;</td></tr>
<tr><td>DeepSkyBlue</td><td style="background-color:#00BFFF">&nbsp;</td></tr>
<tr><td>DimGray</td><td style="background-color:#696969">&nbsp;</td></tr>
<tr><td>DodgerBlue</td><td style="background-color:#1E90FF">&nbsp;</td></tr>
<tr><td>Firebrick</td><td style="background-color:#B22222">&nbsp;</td></tr>
<tr><td>FloralWhite</td><td style="background-color:#FFFAF0">&nbsp;</td></tr>
<tr><td>ForestGreen</td><td style="background-color:#228B22">&nbsp;</td></tr>
<tr><td>Fuchsia</td><td style="background-color:#FF00FF">&nbsp;</td></tr>
<tr><td>Gainsboro</td><td style="background-color:#DCDCDC">&nbsp;</td></tr>
<tr><td>GhostWhite</td><td style="background-color:#F8F8FF">&nbsp;</td></tr>
<tr><td>Gold</td><td style="background-color:#FFD700">&nbsp;</td></tr>
<tr><td>Goldenrod</td><td style="background-color:#DAA520">&nbsp;</td></tr>
<tr><td>Gray</td><td style="background-color:#808080">&nbsp;</td></tr>
<tr><td>Green</td><td style="background-color:#008000">&nbsp;</td></tr>
<tr><td>GreenYellow</td><td style="background-color:#ADFF2F">&nbsp;</td></tr>
<tr><td>Honeydew</td><td style="background-color:#F0FFF0">&nbsp;</td></tr>
<tr><td>HotPink</td><td style="background-color:#FF69B4">&nbsp;</td></tr>
<tr><td>IndianRed</td><td style="background-color:#CD5C5C">&nbsp;</td></tr>
<tr><td>Indigo</td><td style="background-color:#4B0082">&nbsp;</td></tr>
<tr><td>Ivory</td><td style="background-color:#FFFFF0">&nbsp;</td></tr>
<tr><td>Khaki</td><td style="background-color:#F0E68C">&nbsp;</td></tr>
<tr><td>Lavender</td><td style="background-color:#E6E6FA">&nbsp;</td></tr>
<tr><td>LavenderBlush</td><td style="background-color:#FFF0F5">&nbsp;</td></tr>
<tr><td>LawnGreen</td><td style="background-color:#7CFC00">&nbsp;</td></tr>
<tr><td>LemonChiffon</td><td style="background-color:#FFFACD">&nbsp;</td></tr>
<tr><td>LightBlue</td><td style="background-color:#ADD8E6">&nbsp;</td></tr>
<tr><td>LightCoral</td><td style="background-color:#F08080">&nbsp;</td></tr>
<tr><td>LightCyan</td><td style="background-color:#E0FFFF">&nbsp;</td></tr>
<tr><td>LightGray</td><td style="background-color:#D3D3D3">&nbsp;</td></tr>
<tr><td>LightGreen</td><td style="background-color:#90EE90">&nbsp;</td></tr>
<tr><td>LightPink</td><td style="background-color:#FFB6C1">&nbsp;</td></tr>
<tr><td>LightSalmon</td><td style="background-color:#FFA07A">&nbsp;</td></tr>
<tr><td>LightSeaGreen</td><td style="background-color:#20B2AA">&nbsp;</td></tr>
<tr><td>LightSkyBlue</td><td style="background-color:#87CEFA">&nbsp;</td></tr>
<tr><td>LightSlateGray</td><td style="background-color:#778899">&nbsp;</td></tr>
<tr><td>LightSteelBlue</td><td style="background-color:#B0C4DE">&nbsp;</td></tr>
<tr><td>LightYellow</td><td style="background-color:#FFFFE0">&nbsp;</td></tr>
<tr><td>Lime</td><td style="background-color:#00FF00">&nbsp;</td></tr>
<tr><td>LimeGreen</td><td style="background-color:#32CD32">&nbsp;</td></tr>
<tr><td>Linen</td><td style="background-color:#FAF0E6">&nbsp;</td></tr>
<tr><td>Magenta</td><td style="background-color:#FF00FF">&nbsp;</td></tr>
<tr><td>Maroon</td><td style="background-color:#800000">&nbsp;</td></tr>
<tr><td>MediumAquamarine</td><td style="background-color:#66CDAA">&nbsp;</td></tr>
<tr><td>MediumBlue</td><td style="background-color:#0000CD">&nbsp;</td></tr>
<tr><td>MediumOrchid</td><td style="background-color:#BA55D3">&nbsp;</td></tr>
<tr><td>MediumPurple</td><td style="background-color:#9370DB">&nbsp;</td></tr>
<tr><td>MediumSeaGreen</td><td style="background-color:#3CB371">&nbsp;</td></tr>
<tr><td>MediumSlateBlue</td><td style="background-color:#7B68EE">&nbsp;</td></tr>
<tr><td>MediumSpringGreen</td><td style="background-color:#00FA9A">&nbsp;</td></tr>
<tr><td>MediumTurquoise</td><td style="background-color:#48D1CC">&nbsp;</td></tr>
<tr><td>MediumVioletRed</td><td style="background-color:#C71585">&nbsp;</td></tr>
<tr><td>MidnightBlue</td><td style="background-color:#191970">&nbsp;</td></tr>
<tr><td>MintCream</td><td style="background-color:#F5FFFA">&nbsp;</td></tr>
<tr><td>MistyRose</td><td style="background-color:#FFE4E1">&nbsp;</td></tr>
<tr><td>Moccasin</td><td style="background-color:#FFE4B5">&nbsp;</td></tr>
<tr><td>NavajoWhite</td><td style="background-color:#FFDEAD">&nbsp;</td></tr>
<tr><td>Navy</td><td style="background-color:#000080">&nbsp;</td></tr>
<tr><td>OldLace</td><td style="background-color:#FDF5E6">&nbsp;</td></tr>
<tr><td>Olive</td><td style="background-color:#808000">&nbsp;</td></tr>
<tr><td>OliveDrab</td><td style="background-color:#6B8E23">&nbsp;</td></tr>
<tr><td>Orange</td><td style="background-color:#FFA500">&nbsp;</td></tr>
<tr><td>OrangeRed</td><td style="background-color:#FF4500">&nbsp;</td></tr>
<tr><td>Orchid</td><td style="background-color:#DA70D6">&nbsp;</td></tr>
<tr><td>PaleGoldenrod</td><td style="background-color:#EEE8AA">&nbsp;</td></tr>
<tr><td>PaleGreen</td><td style="background-color:#98FB98">&nbsp;</td></tr>
<tr><td>PaleTurquoise</td><td style="background-color:#AFEEEE">&nbsp;</td></tr>
<tr><td>PaleVioletRed</td><td style="background-color:#DB7093">&nbsp;</td></tr>
<tr><td>PapayaWhip</td><td style="background-color:#FFEFD5">&nbsp;</td></tr>
<tr><td>PeachPuff</td><td style="background-color:#FFDAB9">&nbsp;</td></tr>
<tr><td>PeaGreen</td><td style="background-color:#7BAE63">&nbsp;</td></tr>
<tr><td>Peru</td><td style="background-color:#CD853F">&nbsp;</td></tr>
<tr><td>Pink</td><td style="background-color:#FFC0CB">&nbsp;</td></tr>
<tr><td>Plum</td><td style="background-color:#DDA0DD">&nbsp;</td></tr>
<tr><td>PowderBlue</td><td style="background-color:#B0E0E6">&nbsp;</td></tr>
<tr><td>Purple</td><td style="background-color:#800080">&nbsp;</td></tr>
<tr><td>Red</td><td style="background-color:#FF0000">&nbsp;</td></tr>
<tr><td>RedPeach</td><td style="background-color:#CE7163">&nbsp;</td></tr>
<tr><td>RosyBrown</td><td style="background-color:#BC8F8F">&nbsp;</td></tr>
<tr><td>RoyalBlue</td><td style="background-color:#4169E1">&nbsp;</td></tr>
<tr><td>SaddleBrown</td><td style="background-color:#8B4513">&nbsp;</td></tr>
<tr><td>Salmon</td><td style="background-color:#FA8072">&nbsp;</td></tr>
<tr><td>SandyBrown</td><td style="background-color:#F4A460">&nbsp;</td></tr>
<tr><td>SeaGreen</td><td style="background-color:#2E8B57">&nbsp;</td></tr>
<tr><td>SeaShell</td><td style="background-color:#FFF5EE">&nbsp;</td></tr>
<tr><td>Sienna</td><td style="background-color:#A0522D">&nbsp;</td></tr>
<tr><td>Silver</td><td style="background-color:#C0C0C0">&nbsp;</td></tr>
<tr><td>SkyBlue</td><td style="background-color:#87CEEB">&nbsp;</td></tr>
<tr><td>SlateBlue</td><td style="background-color:#6A5ACD">&nbsp;</td></tr>
<tr><td>SlateGray</td><td style="background-color:#708090">&nbsp;</td></tr>
<tr><td>SmoothBlue</td><td style="background-color:#52559C">&nbsp;</td></tr>
<tr><td>Snow</td><td style="background-color:#FFFAFA">&nbsp;</td></tr>
<tr><td>SpringGreen</td><td style="background-color:#00FF7F">&nbsp;</td></tr>
<tr><td>SteelBlue</td><td style="background-color:#4682B4">&nbsp;</td></tr>
<tr><td>Tan</td><td style="background-color:#D2B48C">&nbsp;</td></tr>
<tr><td>Teal</td><td style="background-color:#008080">&nbsp;</td></tr>
<tr><td>Thistle</td><td style="background-color:#D8BFD8">&nbsp;</td></tr>
<tr><td>Tomato</td><td style="background-color:#FF6347">&nbsp;</td></tr>
<tr><td>Turquoise</td><td style="background-color:#40E0D0">&nbsp;</td></tr>
<tr><td>Violet</td><td style="background-color:#EE82EE">&nbsp;</td></tr>
<tr><td>Wheat</td><td style="background-color:#F5DEB3">&nbsp;</td></tr>
<tr><td>White</td><td style="background-color:#FFFFFF">&nbsp;</td></tr>
<tr><td>WhiteSmoke</td><td style="background-color:#F5F5F5">&nbsp;</td></tr>
<tr><td>Yellow</td><td style="background-color:#FFFF00">&nbsp;</td></tr>
<tr><td>YellowGreen</td><td style="background-color:#9ACD32">&nbsp;</td></tr>
</table>

== Color integers ==
A color integer encodes the RGB (red, green and blue) channels, and optionally the Alpha channel, numerically. The value is encoded as:

:<code>0xff000000 * alpha + 0x00ff0000 * red + 0x0000ff00 * green + 0x000000ff * blue</code>
where «alpha», «red», «green» and «blue» are each between 0 and 255 inclusively.  Without the alpha, an RGB number is
:<code>0x00ff0000 * red + 0x0000ff00 * green + 0x000000ff * blue</code>

Color integers are often written in hex, such as <code>0x4682b4</code> for <code>'SteelBlue</code>, where the red is 0x46, the green is 0x82, and the blue is 0xb4.

An «alpha» of 255 (0xff) is totally opaque, and an «alpha» of 1 (0x01) is almost completely transparent. When the alpha is 0x00, built-in function understand this to be an RGB number with full opacity. 

== Color parameters ==

You might define your own user-defined functions that accept a color parameter. For example, the following UDF would return the Red color channel for a color:

:[[UDF|Function]] GetRed( c : [[Function parameter qualifiers#Color|Color]] [[Function parameter qualifiers#Atom|Atom]] ) := <code>[[BitAnd]]([ [[BitShift]](c,16), 0xff ])</code>

:<code>GetRed( ['YellowGreen', 'Olive', 0x12345678] ) &rarr; [ 0x009a, 0x0080, 0x0034 ]</code>
:(''Note: To see the result in Hex, set the number format to Hexadecimal'')

== Built-in functions that have color parameters ==

* [[Canvas]]
* [[CanvasDrawLine]]
* [[CanvasDrawRectangle]]
* [[CanvasDrawEllipse]]
* [[CanvasDrawText]]
* [[CanvasDrawPolygon]]
* [[CellFill]]
* [[CellBar]]

== See Also ==
* [[Function parameter qualifiers#Color]]