Difference between revisions of "TL SetColor"

From MultiCharts
Jump to navigation Jump to search
m (Reverted edits by 176.8.90.7 (talk) to last revision by 194.84.116.138)
 
Line 1: Line 1:
Assigns the specified color to a trendline with the specified ID number; returns a value of 0 if the color was successfully assigned, and a value of -2 if the specified trendline ID number is invalid.  
+
Assigns the specified color to a trendline with the specified ID number.
 +
 
 +
TL_SetColor returns a value of 0 if the color was successfully assigned and a value of -2 if the specified trendline ID number is invalid.  
 
   
 
   
==== Usage ====
+
== Usage ==
 
<syntaxhighlight>TL_SetColor(TL_ID,TL_Color)</syntaxhighlight>  
 
<syntaxhighlight>TL_SetColor(TL_ID,TL_Color)</syntaxhighlight>  
  
==== Parameters ====  
+
== Parameters ==  
[[TL_ID]] - a numerical expression specifying the trendline ID number  
+
:'''TL_ID''' - a numerical expression specifying the trendline ID number.
  
[[TL_Color]] - an expression specifying the trendline color  
+
:'''TL_Color''' - an expression specifying the trendline color.
  
Trendline color can be specified by a numerical expression representing an RGB color number or a legacy color value, or by one of 17 base color words.  
+
::Trendline color can be specified by a numerical expression representing an [[RGB|RGB color number]], a legacy color value, or by one of 17 [[:Category:Colors|base color words]].  
 
   
 
   
==== Notes ====  
+
== 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.  
 
   
 
   
==== Example ====
+
== Example ==
Assign the color blue to the trendline with an ID number of 3:  
+
Assign the [[:Category:Colors|color]] [[blue]] to the trendline with an ID number of 3:  
  
<syntaxhighlight>Value1=TL_SetColor(3,Blue);</syntaxhighlight>
+
<syntaxhighlight>Value1 = TL_SetColor(3, Blue);</syntaxhighlight>
  
Assign the RGB color 2138336 (Orange) to the trendline with an ID number of 3:  
+
Assign the [[RGB]] color 2138336 (Orange) to the trendline with an ID number of 3:  
  
<syntaxhighlight>Value1=TL_SetColor(3,2138336);</syntaxhighlight>
+
<syntaxhighlight>Value1 = TL_SetColor(3, 2138336);</syntaxhighlight>
  
 
Assign the legacy color 4 (Green) to the trendline with an ID number of 3:  
 
Assign the legacy color 4 (Green) to the trendline with an ID number of 3:  
  
<syntaxhighlight>[LegacyColorValue=True];
+
<syntaxhighlight>[LegacyColorValue = True];
Value1=TL_SetColor(3,4);</syntaxhighlight>  
+
Value1 = TL_SetColor(3, 4);</syntaxhighlight>  
  
 
[[Category:Trendline Drawing]]
 
[[Category:Trendline Drawing]]

Latest revision as of 04:40, 3 April 2013

Assigns the specified color to a trendline with the specified ID number.

TL_SetColor returns a value of 0 if the color was successfully assigned and a value of -2 if the specified trendline ID number is invalid.

Usage

TL_SetColor(TL_ID,TL_Color)

Parameters

TL_ID - a numerical expression specifying the trendline ID number.
TL_Color - an expression specifying the trendline color.
Trendline color can be specified by a numerical expression representing an RGB color number, a legacy color value, or by one of 17 base color words.

Notes

  • A trendline-specific ID number is returned by TL_New when the trendline is created.

Example

Assign the color blue to the trendline with an ID number of 3:

Value1 = TL_SetColor(3, Blue);

Assign the RGB color 2138336 (Orange) to the trendline with an ID number of 3:

Value1 = TL_SetColor(3, 2138336);

Assign the legacy color 4 (Green) to the trendline with an ID number of 3:

[LegacyColorValue = True];
Value1 = TL_SetColor(3, 4);