toColor
This function is used by Ignition's Expression language.
Description​
This function tries to convert value to a color. It assumes that value is a string. If you have integers representing Red, Green, and Blue values see the color expression. The string value is converted to a color according to these rules:
- If value is a name of a color as defined in the table below, the corresponding color will be returned. Note that color names are case insensitive.
- If value is a hex color string (with or without a leading "#"), the color equivalent of that hex string will be used. Examples: "#FF0000", "556B2F"
- If value is a list of 3 or 4 integers, a color will be created that uses the first three integers as red, green, and blue values, and the optional fourth integer as an alpha channel value. All values should be between 0 and 255. The list is free-form, any non-digit characters may be used as delimiters between the digits. Examples: "(0,0,0)", "23-99-203", "[255,255,33,127]"
note
This function was designed to return color objects to Vision bindings, and will not work with Perspective bindings. Instead, Perspective color properties can simply use string hex codes to derive a color from a binding, for example: "#00FF00".
Syntax​
toColor(value, [failover])
Parameters​
| Type | Parameter | Description |
|---|---|---|
| String | value | The color value as a string. |
| Object | failover | The failover value if type casting fails. [optional] |
Results​
Color - The value type cast as a color object.
Examples​
Code Snippet
//All of these expressions return the color red.
toColor("red")
toColor("#FF0000")
toColor("255,0,0")
Code Snippet
//You can use the failover parameter to ensure that this expression returns something even if the input string may be bad:
toColor({UserOptions/CustomColor}, "black")
Color Options​
note
Both 'Grey' and 'Gray' are accepted as valid colors, as well as the iterations of that color such as 'DarkGrey' and 'DarkGray'.
| Color | Hex Color String | Example |
|---|---|---|
| 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 |          |
| Clear | see Transparent |          |
| Coral | #FF7F50 |          |
| CornflowerBlue | #6495ED |          |
| Cornsilk | #FFF8DC |          |
| Crimson | #DC143C |          |
| Cyan | #00FFFF |          |
| DarkBlue | #00008B |          |
| DarkCyan | #008B8B |          |
| DarkGoldenRod | #B8860B |          |
| DarkGray DarkGrey | #A9A9A9 |          |
| DarkGreen | #006400 |          |
| DarkKhaki | #BDB76B |          |
| DarkMagenta | #8B008B |          |
| DarkOliveGreen | #556B2F |          |
| Darkorange | #FF8C00 |          |
| DarkOrchid | #9932CC |          |
| DarkRed | #8B0000 |          |
| DarkSalmon | #E9967A |          |
| DarkSeaGreen | #8FBC8F |          |
| DarkSlateBlue | #483D8B |          |
| DarkSlateGray DarkSlateGrey | #2F4F4F |          |
| DarkTurquoise | #00CED1 |          |
| DarkViolet | #9400D3 |          |
| DeepPink | #FF1493 |          |
| DeepSkyBlue | #00BFFF |          |
| DimGray DimGrey | #696969 |          |
| DodgerBlue | #1E90FF |          |
| Feldspar | #D19275 |          |
| FireBrick | #B22222 |          |
| FloralWhite | #FFFAF0 |          |
| ForestGreen | #228B22 |          |
| Fuchsia | #FF00FF |          |
| Gainsboro | #DCDCDC |          |
| GhostWhite | #F8F8FF |          |
| Gold | #FFD700 |          |
| GoldenRod | #DAA520 |          |
| Gray 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 |          |
| LightGreen | #90EE90 |          |
| LightGray LightGrey | #D3D3D3 |          |
| LightPink | #FFB6C1 |          |
| LightSalmon | #FFA07A |          |
| LightSeaGreen | #20B2AA |          |
| LightSkyBlue | #87CEFA |          |
| LightSlateBlue | #8470FF |          |
| LightSlateGray LightSlateGrey | #778899 |          |
| LightSteelBlue | #B0C4DE |          |
| LightYellow | #FFFFE0 |          |
| Lime | #00FF00 |          |
| LimeGreen | #32CD32 |          |
| Linen | #FAF0E6 |          |
| Magenta | #FF00FF |          |
| Maroon | #800000 |          |
| MediumAquaMarine | #66CDAA |          |
| MediumBlue | #0000CD |          |
| MediumOrchid | #BA55D3 |          |
| MediumPurple | #9370DB |          |
| 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 | #DB7093 |          |
| 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 SlateGrey | #708090 |          |
| Snow | #FFFAFA |          |
| SpringGreen | #00FF7F |          |
| SteelBlue | #4682B4 |          |
| Tan | #D2B48C |          |
| Teal | #008080 |          |
| Thistle | #D8BFD8 |          |
| Tomato | #FF6347 |          |
| Transparent | #FFFFFF |          |
| Turquoise | #40E0D0 |          |
| Violet | #EE82EE |          |
| VioletRed | #D02090 |          |
| Wheat | #F5DEB3 |          |
| White | #FFFFFF |          |
| WhiteSmoke | #F5F5F5 |          |
| Yellow | #FFFF00 |          |
| YellowGreen | #9ACD32 |          |