Difference between revisions of "GetTPOinfo"
(Created page with "Returns a numerical value, indicating the units of the specified Style tab setting for the TPO data series that the study is applied to. == Usage == <syntaxhighlight> getTPO...") |
|||
| Line 10: | Line 10: | ||
<br/>tpoOR - reserved for future use (Open Range). | <br/>tpoOR - reserved for future use (Open Range). | ||
<br/>tpoFillZeroLvls - current Show Blocks with Zero Range value on TPO chart. | <br/>tpoFillZeroLvls - current Show Blocks with Zero Range value on TPO chart. | ||
| − | ==Error Codes | + | ==Error Codes== |
-1, current chart resolution is not TPO. | -1, current chart resolution is not TPO. | ||
<br/>-2, wrong constant, unexpected usage. | <br/>-2, wrong constant, unexpected usage. | ||
<br/>-10, when tpoOR (Open Range) is requested. | <br/>-10, when tpoOR (Open Range) is requested. | ||
| + | |||
== Example == | == Example == | ||
Assign a value, indicating the current Price Increment value of the data series that the study is applied to, to the Value1 variable: | Assign a value, indicating the current Price Increment value of the data series that the study is applied to, to the Value1 variable: | ||
Latest revision as of 14:01, 7 November 2018
Returns a numerical value, indicating the units of the specified Style tab setting for the TPO data series that the study is applied to.
Usage
getTPOinfo(style)
Where:
(style) - Valid Parameters:
tpoPI - current Price Increment on TPO chart.
tpoVAPcnt - current Value Area value on TPO chart (in percentages).
tpoVAPcnt2 - current Value Area 2 value on TPO chart (in percentages).
tpoIBR - current Initial Balance Range value on TPO chart (the number of starting TPO intervals).
tpoOR - reserved for future use (Open Range).
tpoFillZeroLvls - current Show Blocks with Zero Range value on TPO chart.
Error Codes
-1, current chart resolution is not TPO.
-2, wrong constant, unexpected usage.
-10, when tpoOR (Open Range) is requested.
Example
Assign a value, indicating the current Price Increment value of the data series that the study is applied to, to the Value1 variable:
value1 = getTPOinfo(tpoPI);
