Difference between revisions of "TL GetBeginVal"

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:
Returns the price value (vertical position, corresponding to a value on the price scale of a chart) of the starting point of a trendline with the specified ID number; returns a value of -2 if the specified trendline ID number is invalid.  
+
Returns the price value (vertical position, corresponding to a value on the price scale of a chart) of the starting point of a trendline with the specified ID number.
  
Of the two end points of a trendline, the point with the earlier date and time is always considered to be the starting point; if the trendline is vertical, the point with the lower price value is considered to be the starting point.  
+
TL_GetBeginVal returns a value of -2 if the specified trendline ID number is invalid.
 +
 
 +
Of the two end points of a trendline, the point with the earlier date and time is always considered to be the starting point. If the trendline is vertical, the point with the lower price value is considered to be the starting point.  
 
   
 
   
==== Usage ====
+
== Usage ==
 
<syntaxhighlight>TL_GetBeginVal(TL_ID)</syntaxhighlight>  
 
<syntaxhighlight>TL_GetBeginVal(TL_ID)</syntaxhighlight>  
  
Where: [[TL_ID]] - a numerical expression specifying the trendline ID number  
+
Where:  
 +
 
 +
:'''TL_ID''' - a numerical expression specifying the trendline ID number,
 
   
 
   
==== 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.
 +
* Use [[TL_GetEndVal]] to get the end value for a specified trendline.
 
   
 
   
==== Example ====
+
== Example ==
Assign a value, indicating the price value of the starting point of a trendline with the ID number of 3, to Value1 variable:  
+
Assign a value, indicating the price value of the starting point of a trendline with the ID number of 3, to the Value1 variable:  
  
<syntaxhighlight>Value1=TL_GetBeginVal(3);</syntaxhighlight>  
+
<syntaxhighlight>Value1 = TL_GetBeginVal(3);</syntaxhighlight>  
 
   
 
   
 
[[Category:Trendline Drawing]]
 
[[Category:Trendline Drawing]]

Latest revision as of 16:56, 8 March 2012

Returns the price value (vertical position, corresponding to a value on the price scale of a chart) of the starting point of a trendline with the specified ID number.

TL_GetBeginVal returns a value of -2 if the specified trendline ID number is invalid.

Of the two end points of a trendline, the point with the earlier date and time is always considered to be the starting point. If the trendline is vertical, the point with the lower price value is considered to be the starting point.

Usage

TL_GetBeginVal(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_GetEndVal to get the end value for a specified trendline.

Example

Assign a value, indicating the price value of the starting point of a trendline with the ID number of 3, to the Value1 variable:

Value1 = TL_GetBeginVal(3);