More actions
jrfconvert import |
No edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{HelpFiles}} | |||
| |||
=====Color_getByRGB===== | ===== Color_getByRGB ===== | ||
This function creates a color object that can be used in some of the other chart style setting functions. | This function creates a color object that can be used in some of the other chart style setting functions. | ||
'''Syntax''' | '''Syntax''' | ||
Color_getByRGB(''number1, number2, number3'') | Color_getByRGB(''number1, number2, number3'') | ||
Color_getByRGB(“''hexadecimal''”) | Color_getByRGB(“''hexadecimal''”) | ||
'''Arguments''' | '''Arguments''' | ||
''number1, number2, number3'': numbers (from 0 to 255) for red color, green color and blue color. | ''number1, number2, number3'': numbers (from 0 to 255) for red color, green color and blue color. | ||
''hexadecimal'': is a hexadecimal value describing a color (a string). | ''hexadecimal'': is a hexadecimal value describing a color (a string). | ||
'''Return type''' | '''Return type''' | ||
Returns the following array | Returns the following array | ||
{| | {| cellpadding="2" border="1" width="907" style="border-collapse: collapse; border: 1px solid rgb(1, 1, 1);" class="tableintopic" | ||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| | | bgcolor="#f59d56" align="center" width="227" valign="middle" style="border: 1px solid rgb(1, 1, 1);" | | ||
Constant | '''Constant''' | ||
| | |||
Type | | bgcolor="#f59d56" align="center" width="227" valign="middle" style="border: 1px solid rgb(1, 1, 1);" | | ||
| | '''Type''' | ||
Initial/Default value | |||
| | | bgcolor="#f59d56" align="center" width="227" valign="middle" style="border: 1px solid rgb(1, 1, 1);" | | ||
Description | '''Initial/Default value''' | ||
| bgcolor="#f59d56" align="center" width="227" valign="middle" style="border: 1px solid rgb(1, 1, 1);" | | |||
'''Description''' | |||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| style="border: 1px solid | | width="227" style="border: 1px solid rgb(1, 1, 1);" | | ||
OBJECT_TYPE | |||
| width="227" style="border: 1px solid rgb(1, 1, 1);" | | |||
Number | |||
| width="227" style="border: 1px solid rgb(1, 1, 1);" | | |||
Enumeration for the type of object. | 17 | ||
| width="227" style="border: 1px solid rgb(1, 1, 1);" | | |||
Enumeration for the type of object. | |||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| style="border: 1px solid | | width="227" style="border: 1px solid rgb(1, 1, 1);" | | ||
COLOR_RED | |||
| width="227" style="border: 1px solid rgb(1, 1, 1);" | | |||
Number | |||
As set in function | |||
| style="border: 1px solid | | width="227" style="border: 1px solid rgb(1, 1, 1);" | | ||
Color code between 0 and 255 | As set in function | ||
| width="227" style="border: 1px solid rgb(1, 1, 1);" | | |||
Color code between 0 and 255 | |||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| style="border: 1px solid | | width="227" style="border: 1px solid rgb(1, 1, 1);" | | ||
COLOR_GREEN | |||
| width="227" style="border: 1px solid rgb(1, 1, 1);" | | |||
Number | |||
As set in function | |||
| style="border: 1px solid | | width="227" style="border: 1px solid rgb(1, 1, 1);" | | ||
Color code between 0 and 255 | As set in function | ||
| width="227" style="border: 1px solid rgb(1, 1, 1);" | | |||
Color code between 0 and 255 | |||
|- align="left" valign="top" | |- align="left" valign="top" | ||
| style="border: 1px solid | | width="227" style="border: 1px solid rgb(1, 1, 1);" | | ||
COLOR_BLUE | |||
| width="227" style="border: 1px solid rgb(1, 1, 1);" | | |||
Number | |||
As set in function | |||
| style="border: 1px solid | | width="227" style="border: 1px solid rgb(1, 1, 1);" | | ||
Color code between 0 and 255 | As set in function | ||
| width="227" style="border: 1px solid rgb(1, 1, 1);" | | |||
Color code between 0 and 255 | |||
|} | |||
'''Examples''' | |||
''array color1 = Color_getByRGB(255, 255, 0); // Yellow '' | |||
'' | ''array color2 = Color_getByRGB(“#000000”); // Black '' | ||
''{{note}} This function should be paired with function DiagramFontStyle, DiagramFillStyle'' | |||
'''Availability''' | |||
Version 5.8.1 __NOTOC__ <!-- imported from file: 8097.htm--> | |||
[[Category:Style_setting_functions]] | |||
Latest revision as of 04:50, 30 December 2011
Color_getByRGB
This function creates a color object that can be used in some of the other chart style setting functions.
Syntax
Color_getByRGB(number1, number2, number3)
Color_getByRGB(“hexadecimal”)
Arguments
number1, number2, number3: numbers (from 0 to 255) for red color, green color and blue color.
hexadecimal: is a hexadecimal value describing a color (a string).
Return type
Returns the following array
|
Constant |
Type |
Initial/Default value |
Description |
|
OBJECT_TYPE |
Number |
17 |
Enumeration for the type of object. |
|
COLOR_RED |
Number |
As set in function |
Color code between 0 and 255 |
|
COLOR_GREEN |
Number |
As set in function |
Color code between 0 and 255 |
|
COLOR_BLUE |
Number |
As set in function |
Color code between 0 and 255 |
Examples
array color1 = Color_getByRGB(255, 255, 0); // Yellow
array color2 = Color_getByRGB(“#000000”); // Black
Note: This function should be paired with function DiagramFontStyle, DiagramFillStyle
Availability
Version 5.8.1