Colour class
The Colour class contains constants relating to colours. More...
The T/HIS JavaScript API provides many class constants, properties and methods. For Arup to
be able to extend and enhance the API in the future any constant, property or method names beginning with a lowercase
or uppercase letter are reserved.
If you need to add your own properties or methods to one of the existing classes then to avoid any potential future conflict you
should ensure that the name begins with either an underscore (_) or a dollar sign ($) or the name is prefixed with your
own unique identifier.
For example if company 'ABC' need to add a property called 'example' then to avoid any potential future conflict use one of:
- _example
- $example
- ABC_example
Class functions
- GetFromName(name[string])
- RGB(red[integer], green[integer], blue[integer])
Colour constants
| Name |
Description |
| Colour.BACKGROUND |
Background colour |
| Colour.BLACK |
Colour black |
| Colour.BLUE |
Colour blue |
| Colour.CYAN |
Colour cyan |
| Colour.DARK_GREEN |
Colour dark green |
| Colour.DARK_GREY |
Colour dark grey |
| Colour.DARK_MAGENTA |
Colour dark magenta |
| Colour.FOREGROUND |
Foreground colour |
| Colour.GOLD |
Colour gold |
| Colour.GREEN |
Colour green |
| Colour.HOT_PINK |
Colour hot pink |
| Colour.INDIGO |
Colour indigo |
| Colour.LIGHT_GREY |
Colour light grey |
| Colour.LIGHT_PINK |
Colour light pink |
| Colour.LIME |
Colour lime |
| Colour.MAGENTA |
Colour magenta |
| Colour.MAROON |
Colour maroon |
| Colour.MEDIUM_BLUE |
Colour medium blue |
| Colour.MEDIUM_GREEN |
Colour medium green |
| Colour.MEDIUM_GREY |
Colour medium grey |
| Colour.NAVY |
Colour navy |
| Colour.OLIVE |
Colour olive |
| Colour.ORANGE |
Colour orange |
| Colour.PALE_YELLOW |
Colourpale yellow |
| Colour.PINK |
Colour pink |
| Colour.PURPLE |
Colour purple |
| Colour.RED |
Colour red |
| Colour.SEA_GREEN |
Colour sea green |
| Colour.SKY |
Colour sky |
| Colour.TURQUOISE |
Colour turquoise |
| Colour.USER_1 |
Colour user defined 1 |
| Colour.USER_2 |
Colour user defined 2 |
| Colour.USER_3 |
Colour user defined 3 |
| Colour.USER_4 |
Colour user defined 4 |
| Colour.USER_5 |
Colour user defined 5 |
| Colour.USER_6 |
Colour user defined 6 |
| Colour.USER_n (n = 1 to 150) |
n-th user defined colour |
| Colour.WHITE |
Colour white |
| Colour.YELLOW |
Colour yellow |
Detailed DescriptionThe Colour class is used to define colours:
|
p.colour = Colour.RED;
Details of functions
GetFromName(name[string])
[static]
DescriptionReturns the colour for a given core or user colour name
|
Arguments
name (string)
The name of the colour, for example red or user_green or green/cyan.
Returns
colour value (integer)
Return type
Number
|
RGB(red[integer], green[integer], blue[integer])
[static]
DescriptionCreates a colour from red, green and blue components
|
Arguments
red (integer)
red component of colour (0-255).
green (integer)
green component of colour (0-255).
blue (integer)
blue component of colour (0-255).
Returns
colour value (integer)
Return type
Number
|