(10 intermediate revisions by the same user not shown)
Line 40:
Line 40:
=== Indicators return value list ===
=== Indicators return value list ===
For each indicator included in a rule, the selected return value can be different.
For each indicator included in a rule, the selected return value can be different.
As an example, if the use wants to use the Bollinger Bands indicator in his own rules, he can select the value of Up Band, Middle band or Down Band.
As an example, if the user wants to use the Bollinger Bands indicator in his own rules, he can select the value of Up Band, Middle band or Down Band.
These values are stored as IndicatorBuffer objects in the [[Indicators_API|NakedMarkets API]]. These can be reviewed for all indicators on our [https://github.com/NakedMarkets/Indicators Github] since their source code is public.
These values are stored as IndicatorBuffer objects in the [[Indicators_API|NakedMarkets API]]. These can be reviewed for all indicators on our [https://github.com/NakedMarkets/Indicators Github] since their source code is public.
The return value will appear in the Rule indicator properties form if the indicator has called the SetIndexStyle() and SetIndexLabel() functions.
The return value will appear in the Rule indicator properties form if the indicator has called the SetIndexStyle() and SetIndexLabel() functions.
For information, if an indicator does not have return or calculated values (ie : trading sessions indicator), it will not be displayed in the related category under the Rule Manager.
For information, if an indicator does not have returned or calculated values (ie : trading sessions indicator), it will not be displayed in the related category under the Rule Manager.
Here is the list of return value of all native indicators under NakedMarkets :
All returned value are float values. These value depend on the calculations made within the Indicator and can be read on our Github.<br>
However, we added notes for some indicators particularities if needed. If there is no notes, it means that the returned value are the current indicator values. For example, the Ichimoku Tenkan Sen value will return the current Tenkan Sen value displayed by the indicator.
! style="width: 333.783px; height: 28px;" | Indicator name !! style="height: 28px; width: 817.483px;" colspan="5" | Returned values
|- style="height: 28px;"
The indicators can have particularities when the buffers are not aimed to be directly displayed as drawing lines or histogram (ie : arrows or sections).
The Fractal Up contains the High of the bar where a Fractal is displayed, otherwise it contains Double.NaN if no Fractal is displayed. The Fractal Down contains the Low of the bar where a Fractal is displayed.<br>
The ZigZag value contains the High or the Low of each line displayed on the chart. If no new line is created, no new highs, or lows, the value contains Double.NaN.<br>
This Indicators category contains all Default Rules using the Indicators on the Charts.
You can access every Indicator installed in Naked Markets, the default and the custom ones. Thus, every rule in this category is a Value Rule. This means that it returns always a number value and not a condition (True or False).
You can specify which data you want to get from the Indicator
Indicators
Every Indicator Rules will return the data value defined by the Rule, identified by the "Selected Value" option in the Indicator Parameters form.
Example with the Bollinger Band Indicator :
Common Parameters
Selected Value : This is the value returned by the Indicator Rule. It depends on the Indicator you want to use. In the Bollinger Band above example, we can select the UpperBand, the MiddleBand or the LowerBand.
Bar Position : Position of the Bar on the current chart. "0" is the last printed Bar on the chart. "1" is the previous Bar from the last Bar. "2" is the second previous Bar from the last Bar.
Timeframe : Timeframe of the Bar. It's advised to let the value "Current" to get the value of the Bar on the current chart.
Symbol : Symbol of the Bar. It's advised to let the value "Current" to get the value of the Bar on the current chart.
Indicator specific Parameters
The list depends on the indicator you use in the Rule. This is the list of parameters you choose when you attach the Indicator on the Chart.
In the previous example with the Bollinger Bands, these are : Period, Deviation, Shift, ...
Indicators return value list
For each indicator included in a rule, the selected return value can be different.
As an example, if the user wants to use the Bollinger Bands indicator in his own rules, he can select the value of Up Band, Middle band or Down Band.
These values are stored as IndicatorBuffer objects in the NakedMarkets API. These can be reviewed for all indicators on our Github since their source code is public.
The return value will appear in the Rule indicator properties form if the indicator has called the SetIndexStyle() and SetIndexLabel() functions.
For information, if an indicator does not have returned or calculated values (ie : trading sessions indicator), it will not be displayed in the related category under the Rule Manager.
All returned value are float values. These value depend on the calculations made within the Indicator and can be read on our Github.
However, we added notes for some indicators particularities if needed. If there is no notes, it means that the returned value are the current indicator values. For example, the Ichimoku Tenkan Sen value will return the current Tenkan Sen value displayed by the indicator.
The indicators can have particularities when the buffers are not aimed to be directly displayed as drawing lines or histogram (ie : arrows or sections).
Here is the list of return value of all native indicators under NakedMarkets :
Indicator name
Returned values
Notes
Accelerator Oscillator
AC1
AC2
ADX (Average Directional Movement Index)
ADX
+Di
-Di
Alligator
Jaws
Teeth
Lips
AMA (Adaptative Moving Average)
AMA
Awesome Oscillator (B. Williams)
SMA1
SMA2
Aroon
Buffer1
Buffer2
Average True Range
ATR
Bears Power
Bears Power
Bollinger Bands
Up Band
MA
Down Band
Bulls Power
Bulls Power
CCI (Commodity Channel Index)
CCI
DeMarker
DeMarker
Donchian Channel
Upper Donchian
Lower Donchian
Midline Donchian
Envelopes
Envelope Up
Envelope Down
Fractals
Fractal Up
Fractal Down
Buffer Type = DrawingStyle.DRAW_ARROW.
The Fractal Up contains the High of the bar where a Fractal is displayed, otherwise it contains Double.NaN if no Fractal is displayed. The Fractal Down contains the Low of the bar where a Fractal is displayed.
FTLM-STLM
FTLM
STLM
HMA (Hull Moving Average)
HMA Up
HMA Down
Ichimoku
Tenkan Sen
Kijun Sen
Chinkou Span
Senkou Span A
Senkou Span B
Keltner Channels
Upper band
Middle band
Lower band
MACD
MACD
Signal line
MACD (new version)
MACD
Signal line
MACD - Signal line
MACD (TV version)
MACD
Signal line
Histogram
Momentum
Momentum
Moving Average
Moving Average
OBV (On Balance Volume)
OBV
PSAR (Parabolic Stop And Reverse)
PSAR
PCCI (Perfect Commodity Channel Index)
PCCI
PFE (Polarized Fractal Efficiency)
PFE
Pivots points
R3, R2, R1, PP, S1, S2, S3, M1, M2, M3, M4
Price channel
Up Band
Down Band
ROC (Rate Of Change)
ROC
RSI (Relative Strength Index)
RSI
Solar Wind
Up Buff
Down Buff
Stochastic
K Line
D Line
Support & Resistance
Resistance
Support
TDI (Traders Dynamic Index)
VB High
Market Base Line
VB Low
RSI Price Line
Trade Signal Line
Range Expansions Index
REI
Ultimate Oscillator
Ultimate Oscillator
Volume
Volume
%R : Percent Range (B. Williams)
%R
ZigZag
ZigZag
Buffer Type = DrawingStyle.DRAW_LINE.
The ZigZag value contains the High or the Low of each line displayed on the chart. If no new line is created, no new highs, or lows, the value contains Double.NaN.