desktop:desktop_chart_scripting_function_reference [WIKI]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Function Reference ======

====== Fields ======
Fields are values that can be referenced directly in a script. For example CLOSE (or C in shorthand) represents the closing price of the current bar of the calculation.

----
<datatables>
^ Field ^ Description ^
| [[desktop:desktop_chart_scripting_function_reference_open|OPEN]] | Opening price|
| [[desktop:desktop_chart_scripting_function_reference_high|HIGH]] | High Price |
| [[desktop:desktop_chart_scripting_function_reference_low|LOW]] | Low Price |
| [[desktop:desktop_chart_scripting_function_reference_close|CLOSE]] | Closing price |
| [[desktop:desktop_chart_scripting_function_reference_typical|TYPICAL]], [[desktop:desktop_chart_scripting_function_reference_typ|TYP]] | Typical price (OPEN + HIGH + CLOSE) / 3 |
| [[desktop:desktop_chart_scripting_function_reference_volume|VOLUME]] | Volume |
| [[desktop:desktop_chart_scripting_function_reference_volumeatbid|VOLUMEATBID]] | Volume that occurred at the bid price. |
| [[desktop:desktop_chart_scripting_function_reference_volumeatoffer|VOLUMEATEOFFER]] | Volume that occurred at the offer price. |
| [[desktop:desktop_chart_scripting_function_reference_trades|TRADES]]| Number of trades that make up the current bar. |
| [[desktop:desktop_chart_scripting_function_reference_tradesatbid|TRADESATBID]]| Number of trades that occurred at the bidprice. |
| [[desktop:desktop_chart_scripting_function_reference_tradesatoffer|TRADESATOFFER]] | Number of trades that occurred at the offer price. |
| [[desktop:desktop_chart_scripting_function_reference_index|INDEX]] | Index of the current bar being computed. This runs from 0 to COUNT - 1. |
| [[desktop:desktop_chart_scripting_function_reference_count|COUNT]] | Number of bars on the chart. |
| [[desktop:desktop_chart_scripting_function_reference_barpercent|BARPERCENT]] | Percentage completion of the current bar. E.g. 15 minutes into a 1 hour bar would give 0.25 |
| [[desktop:desktop_chart_scripting_function_reference_numerator|NUMERATOR]] | The numerator of the market.|
| [[desktop:desktop_chart_scripting_function_reference_demoninator|DENOMINATOR]] | The denominator of the market.|
| [[desktop:desktop_chart_scripting_function_reference_tickvalue|TICKVALUE]] | The tick value of the market. |
| [[desktop:desktop_chart_scripting_function_reference_nil|NIL]] | Special "non-value" field. |
| [[desktop:desktop_chart_scripting_function_reference_marketid|MARKETID]]| The text market id. |
| [[desktop:desktop_chart_scripting_function_reference_marketdescription|MARKETDESCRIPTION]] | The text description of the market. |
</datatables>


----




====== Operators ======


----
<datatables>
^ Arithmetic Operators ^^
^ Operator ^ Description^
| + | Add |
| - | Subtract |
| / | Divide |
| * | Multiply |
| %| Modulus |
|{{glyphicon>chevron-up}}|Exponent |
</datatables>


----

<datatables>
^ Relational Operators ^^
^ Operator ^ Description^
| =, != | Equals, not equals |
| <, <= | Less than, less than equals |
| >, >= | Greater than, greater than equals |
</datatables>

----
<datatables>
^ Boolean Operators ^^
^ Operator ^ Description^
| AND, && | Logical AND |
| OR,{{glyphicon>pause}}  | Logical OR |
| XOR | Exclusive OR |
</datatables>


----

====== Functions ======

----
<datatables>
^Mathematical Functions^^
^ Function ^ Description ^
|[[desktop:desktop_chart_scripting_function_reference_ABS( <value> )|ABS( <value> )]]| Calculates the absolute value of a number.|
|[[desktop:desktop_chart_scripting_function_reference_ACCUM( <value> )|ACCUM( <value> )]]| Accumulates (sums) a value over all the data points on the chart.|
|[[desktop:desktop_chart_scripting_function_reference_ACOS( <value> )|ACOS( <value> )]]| Computes the inverse cosine of the value.|
|[[desktop:desktop_chart_scripting_function_reference_ASIN( <value> )|ASIN( <value> )]]| Computes the inverse sin of the value.|
|[[desktop:desktop_chart_scripting_function_reference_ATAN( <value> )|ATAN( <value> )]]| Computes the inverse tan of the value.|
|[[desktop:desktop_chart_scripting_function_reference_CASH( <value> )|CASH( <value> )]]| Converts the specified tick value to a cash value using the conversion parameters defined for the current market.|
|[[desktop:desktop_chart_scripting_function_referenceCASHTICKS( <value> )|CASHTICKS( <value> )]]|Converts the specified cash value to a tick value using the conversion parameters defined for the current market.|
|[[desktop:desktop_chart_scripting_function_referenceCEILING( <value> )|CEILING( <value> )]]| Computes the nearest larger integer to the value.|
|[[desktop:desktop_chart_scripting_function_reference_COS( <value> )|COS( <value> )]]| Computes the cosine of the value.|
|[[desktop:desktop_chart_scripting_function_reference_CROSS_ABOVE( <value1>, <value2> )|CROSS_ABOVE( <value1>, <value2> )]]| Determines when value1 crosses above value2.|
|[[desktop:desktop_chart_scripting_function_reference_CROSS_BELOW( <value1>, <value2> )|CROSS_BELOW( <value1>, <value2> )]]| Determines when value1 crosses below value2.|
|[[desktop:desktop_chart_scripting_function_reference_DISPLAY( <value> )|DISPLAY( <value> )]]| Formats the specified tick value to a text representation of the price.|
|[[desktop:desktop_chart_scripting_function_reference_EMA( <value> )|EMA( <value> )]]| Computes an exponential moving average of the value.|
|[[desktop:desktop_chart_scripting_function_reference_FLOOR( <value> )|FLOOR( <value> )]]| Computes the nearest smaller integer to the value.|
|[[desktop:desktop_chart_scripting_function_reference_HIGHEST( <value>, <periods> )|HIGHEST( <value>, <periods> )]]|Returns the highest value occurring over the last number of periods from the current data point.|
|[[desktop:desktop_chart_scripting_function_reference_INPUT( <value 1>, ... <value n> )|INPUT( <value 1>, ... <value n> )]]| Allows for user input into the script via property pages.|
|[[desktop:desktop_chart_scripting_function_reference_HMA( <value> )|HMA( <value> )]]| Computes a hull moving average of the value.|
|[[desktop:desktop_chart_scripting_function_reference_LASTVAL( <value>, <periods> )|LASTVAL( <value>, <periods> )]]|Returns the nearest non-Nil value over the last number of periods for the current data point.|
|[[desktop:desktop_chart_scripting_function_reference_LWMA( <value> )|LWMA( <value> )]]|Computes a linear weighted moving average of the value.|
|[[desktop:desktop_chart_scripting_function_reference_LN( <value> )|LN( <value> )]]|Computes the natural (base e) logarithm of the value.|
|[[desktop:desktop_chart_scripting_function_reference_Log( <value> )|LOG( <value>, <base> )]]|Computes the logarithm of the value in the specified base.|
|[[desktop:desktop_chart_scripting_function_reference_LOG10( <value> )|LOG10( <value> )]]|Computes the base 10 logarithm of the value.|
|[[desktop:desktop_chart_scripting_function_reference_LOWEST( <value>, <periods> )|LOWEST( <value>, <periods> )]]|Returns the lowest value occurring over the last number of periods from the current data point.|
|[[desktop:desktop_chart_scripting_function_reference_LSMA( <value> )|LSMA( <value> )]]|Computes a least square moving average of the value.|
|[[desktop:desktop_chart_scripting_function_reference_MAX( <value 1>, ... <value n> )|MAX( <value 1>, ... <value n> )]]| Returns the largest of the specified values.|
|[[desktop:desktop_chart_scripting_function_reference_MIN( <value 1>, ... <value n> )|MIN( <value 1>, ... <value n> )]]| Returns the smallest of the specified values.|
|[[desktop:desktop_chart_scripting_function_reference_MOD( <value 1>, <value 2> )|MOD( <value 1>, <value 2> )]]|Returns the remainder of the division of value 1 by value 2.|
|[[desktop:desktop_chart_scripting_function_reference_MOV( <value>, <periods>, <MAType> )|MOV( <value>, <periods>, <MAType> )]]|Computes the moving average of the value over the specified number of periods using the specified moving average type.|
|[[desktop:desktop_chart_scripting_function_reference_OFFSET( <value>, <periods> )|OFFSET( <value>, <periods> )]]|Gets the value offset by the specified number of periods.|
|[[desktop:desktop_chart_scripting_function_reference_POW( <value>, <power> )|POW( <value>, <power> )]]|Computes the value raised to the specified power.|
|[[desktop:desktop_chart_scripting_function_reference_ROC( <value>, <periods> )|ROC( <value>, <periods> )]]| Computes the rate of change of the specified value over the specified number of periods.|
|[[desktop:desktop_chart_scripting_function_reference_SIN( <value> )|SIN( <value> )]]	|Computes the sine of the value.|
|[[desktop:desktop_chart_scripting_function_reference_SMA( <value> )|SMA( <value> )]]|Computes a simple moving average of the value.|
|[[desktop:desktop_chart_scripting_function_reference_SMMA( <value> )|SMMA( <value> )]]|Computes a smoothed moving average of the value.|
|[[desktop:desktop_chart_scripting_function_reference_SQRT( <value> )|SQRT( <value> )]]|Computes the square root of the value.|
|[[desktop:desktop_chart_scripting_function_reference_STDDEV( <value>, <periods> )|STDDEV( <value>, <periods> )]]|Computes the standard deviation of the value over the specified number of periods.|
|[[desktop:desktop_chart_scripting_function_reference_STDDEVP( <value>, <periods> )|STDDEVP( <value>, <periods> )]]|Computes the standard deviation (entire population) of the value over the specified number of periods.|
|[[desktop:desktop_chart_scripting_function_reference_SUM( <value>, <periods> )|SUM( <value>, <periods> )]]|Computes the sum of the values over the specified number of periods.|
|[[desktop:desktop_chart_scripting_function_reference_SQRT( <value> )|SQRT( <value> )]]| Calculates the square root of a number.|
|[[desktop:desktop_chart_scripting_function_reference_TAN( <value> )|TAN( <value> )]]	|Calculates the tangent of the value.|
|[[desktop:desktop_chart_scripting_function_reference_WILDERMA( <value> )|WILDERMA( <value> )]]|Computes a Wells Wilder simple moving average of the value.|
</datatables>




----

====== Plotting, Summary and Configuration Functions ======


----


<datatables>
^ Field ^ Description ^
| [[desktop:desktop_chart_scripting_function_reference_plot_line(...)|PLOT_LINE(...)]] | Draws a line plot of the value.|
| [[desktop:desktop_chart_scripting_function_reference_PLOT_BAND(...)|PLOT_BAND(...)]] | Draws a line plot of the value with upper and lower bands and option shading between the bands.|
| [[desktop:desktop_chart_scripting_function_reference_PLOT_STEP(...)|PLOT_STEP(...)]] | Draws a step plot of the value. |
| [[desktop:desktop_chart_scripting_function_reference_PLOT_POINTS(...)|PLOT_POINTS(...)]] | Draws a point plot of the value. |
| [[desktop:desktop_chart_scripting_function_reference_PLOT_RIBBON(...)|PLOT_RIBBON(...)]]| Draws a ribbon plot of the value. |
| [[desktop:desktop_chart_scripting_function_reference_PLOT_WAVECREST(...)|PLOT_WAVECREST(...)]] | Draws a wavecrest plot of the value with upper and lower limit lines. Peaks and valleys extending beyond the limit line values are shaded to stand out. |
| [[desktop:desktop_chart_scripting_function_reference_PLOT_HISTOGRAM(...)|PLOT_HISTOGRAM(...)]]| Draws a histogram (columnar) plot of the value. |
| [[desktop:desktop_chart_scripting_function_reference_PLOT_LIMITLINE(...)|PLOT_LIMITLINE(...)]] | Draws a histogram (columnar) plot of the value.|
| [[desktop:desktop_chart_scripting_function_reference_PLOT_CENTERLINE(...)|PLOT_CENTERLINE(...)]] | Draws a histogram (columnar) plot of the value. |
| [[desktop:desktop_chart_scripting_function_reference_PLOT_RANGEMARKERS(...)|PLOT_RANGEMARKERS(...)]] | Draws a histogram (columnar) plot of the value.|
| [[desktop:desktop_chart_scripting_function_reference_SUMMARY(...)|SUMMARY(...)]]| Displays a summary for the plot.|
</datatables>


----