TL GetStyle: Difference between revisions
From MultiCharts
(Created page with "Returns a numerical value, indicating the style of a trendline with the specified ID number; returns a value of -2 if the specified trendline ID number is invalid. ==== Usa...") |
No edit summary |
||
| Line 1: | Line 1: | ||
Returns a numerical value, indicating the style of a trendline with the specified ID number | Returns a numerical value, indicating the style of a trendline with the specified ID number. | ||
TL_GetStyle returns a value of -2 if the specified trendline ID number is invalid. | |||
== Usage == | |||
<syntaxhighlight>TL_GetStyle(TL_ID)</syntaxhighlight> | <syntaxhighlight>TL_GetStyle(TL_ID)</syntaxhighlight> | ||
Where: | Where: | ||
:'''TL_ID''' - a numerical expression specifying the trendline ID number. | |||
== Return == | |||
Trendline styles: | Trendline styles: | ||
{| | :{| | ||
|1 | |1 | ||
|Tool Solid | |Tool Solid | ||
| Line 15: | Line 18: | ||
|2 | |2 | ||
|Tool Dashed | |Tool Dashed | ||
| | |<nowiki>- - - - - - - - - - - - - - - - - - -</nowiki> | ||
|- | |- | ||
|3 | |3 | ||
| Line 29: | Line 32: | ||
|___ _ _ ___ _ _ ___ _ _ ___ | |___ _ _ ___ _ _ ___ _ _ ___ | ||
|} | |} | ||
A trendline | == Notes == | ||
* A trendline specific ID number is returned by [[TL_New]] or [[TL_New_s]] when the trendline is created. | |||
* Use [[TL_SetStyle]] to set the style of a specific trendline. | |||
== Example == | |||
Assign a value, indicating the style of a trendline with the ID number of 3, to Value1 variable: | Assign a value, indicating the style of a trendline with the ID number of 3, to Value1 variable: | ||
<syntaxhighlight>Value1=TL_GetStyle(3);</syntaxhighlight> | <syntaxhighlight>Value1 = TL_GetStyle(3);</syntaxhighlight> | ||
[[Category:Trendline Drawing]] | [[Category:Trendline Drawing]] | ||
Latest revision as of 05:38, 3 April 2013
Returns a numerical value, indicating the style of a trendline with the specified ID number.
TL_GetStyle returns a value of -2 if the specified trendline ID number is invalid.
Usage
TL_GetStyle(TL_ID)Where:
- TL_ID - a numerical expression specifying the trendline ID number.
Return
Trendline styles:
1 Tool Solid ______________________ 2 Tool Dashed - - - - - - - - - - - - - - - - - - - 3 Tool Dotted ............................................ 4 Tool Dashed2 __ _ __ _ __ _ __ _ __ _ __ 5 Tool Dashed3 ___ _ _ ___ _ _ ___ _ _ ___
Notes
- A trendline specific ID number is returned by TL_New or TL_New_s when the trendline is created.
- Use TL_SetStyle to set the style of a specific trendline.
Example
Assign a value, indicating the style of a trendline with the ID number of 3, to Value1 variable:
Value1 = TL_GetStyle(3);