Difference between revisions of "TL GetEndVal"

From MultiCharts
Jump to navigation Jump to search
(Created page with "Returns the price value (vertical position, corresponding to a value on the price scale of a chart) of the ending point of a trendline with the specified ID number; returns a ...")
 
 
Line 1: Line 1:
Returns the price value (vertical position, corresponding to a value on the price scale of a chart) of the ending 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 ending point of a trendline with the specified ID number.
  
Of the two end points of a trendline, the point with the later date and time is always considered to be the ending point; if the trendline is vertical, the point with the higher price value is considered to be the ending point.  
+
TL_GetEndVal 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 later date and time is always considered to be the ending point. If the trendline is vertical, the point with the higher price value is considered to be the ending point.  
 
   
 
   
==== Usage ====
+
== Usage ==
 
<syntaxhighlight>TL_GetEndVal(TL_ID)</syntaxhighlight>  
 
<syntaxhighlight>TL_GetEndVal(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 GetBeginVal]] to get the begin value of a trendline.
 
   
 
   
==== Example ====
+
== Example ==
Assign a value, indicating the price value of the ending point of a trendline with the ID number of 3, to Value1 variable:  
+
Assign a value, indicating the price value of the ending point of a trendline with the ID number of 3, to the Value1 variable:  
  
 
<syntaxhighlight>Value1=TL_GetEndVal(3);</syntaxhighlight>  
 
<syntaxhighlight>Value1=TL_GetEndVal(3);</syntaxhighlight>  

Latest revision as of 16:47, 8 March 2012

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

TL_GetEndVal 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 later date and time is always considered to be the ending point. If the trendline is vertical, the point with the higher price value is considered to be the ending point.

Usage

TL_GetEndVal(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 GetBeginVal to get the begin value of a trendline.

Example

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

Value1=TL_GetEndVal(3);