Difference between revisions of "TL GetColor"
Jump to navigation
Jump to search
(Created page with "Returns an RGB color number or a legacy color value that correspond to the color of a trendline with the specified ID number; returns a value of -2 if the specified trendline ...") |
|||
| Line 1: | Line 1: | ||
| − | Returns an RGB color number or a legacy color value that correspond to the color of a trendline with the specified ID number | + | Returns an [[RGB]] color number or a [[LegacyColorValue|legacy color value]] that correspond to the color of a trendline with the specified ID number. |
| + | |||
| + | TL_GetColor returns a value of -2 if the specified trendline ID number is invalid. | ||
| − | + | == Usage == | |
<syntaxhighlight>TL_GetColor(TL_ID)</syntaxhighlight> | <syntaxhighlight>TL_GetColor(TL_ID)</syntaxhighlight> | ||
| − | Where: | + | Where: |
| + | |||
| + | :'''TL_ID''' - a numerical expression specifying the trendline ID number. | ||
| − | + | == Notes == | |
| − | A trendline-specific ID number is returned by [[TL_New]] when the trendline is created. | + | * A trendline-specific ID number is returned by [[TL_New]] when the trendline is created. |
| + | * Use [[TL_SetColor]] to set the color for a specified trendline. | ||
| − | + | == Example == | |
| − | Assign an RGB color number, corresponding to the color of a trendline with the ID number of 3, to Value1 variable: | + | Assign an [[RGB]] color number, corresponding to the color of a trendline with the ID number of 3, to the Value1 variable: |
| + | |||
| + | <syntaxhighlight>Value1 = TL_GetColor(3);</syntaxhighlight> | ||
| − | + | Assign a [[LegacyColorValue|legacy color value]], corresponding to the color of a trendline with the ID number of 3, to the Value1 variable: | |
| − | + | <syntaxhighlight>[LegacyColorValue = True]; | |
| − | + | Value1 = TL_GetColor(3);</syntaxhighlight> | |
| − | Value1=TL_GetColor(3);</syntaxhighlight> | ||
Latest revision as of 16:55, 8 March 2012
Returns an RGB color number or a legacy color value that correspond to the color of a trendline with the specified ID number.
TL_GetColor returns a value of -2 if the specified trendline ID number is invalid.
Usage
TL_GetColor(TL_ID)
Where:
- TL_ID - a numerical expression specifying the trendline ID number.
Notes
- A trendline-specific ID number is returned by TL_New when the trendline is created.
- Use TL_SetColor to set the color for a specified trendline.
Example
Assign an RGB color number, corresponding to the color of a trendline with the ID number of 3, to the Value1 variable:
Value1 = TL_GetColor(3);
Assign a legacy color value, corresponding to the color of a trendline with the ID number of 3, to the Value1 variable:
[LegacyColorValue = True];
Value1 = TL_GetColor(3);
