iAlligator - MQL5 Documentation

Documentation

MQL5 ReferenceTechnical IndicatorsiAlligator

MQL5 Help as One File:

CHM (1.7 Mb)

PDF (8 Mb)

iAlligator

The function returns the handle of the Alligator indicator.

int  iAlligator(
   string              symbol,            // symbol name
   ENUM_TIMEFRAMES     period,            // period
   int                 jaw_period,        // period for the calculation of jaws
   int                 jaw_shift,         // horizontal shift of jaws
   int                 teeth_period,      // period for the calculation of teeth
   int                 teeth_shift,       // horizontal shift of teeth
   int                 lips_period,       // period for the calculation of lips
   int                 lips_shift,        // horizontal shift of lips
   ENUM_MA_METHOD      ma_method,         // type of smoothing
   ENUM_APPLIED_PRICE  applied_price      // type of price or handle
   );

Parameters

symbol

[in] The symbol name of the security, the data of which should be used to calculate the indicator. The NULL value means the current symbol.

period

[in] The value of the period can be one of the ENUM_TIMEFRAMES values, 0 means the current timeframe.

jaw_period

[in] Averaging period for the blue line (Alligator's Jaw)

jaw_shift

[in] The shift of the blue line relative to the price chart. It should be remembered that the line shift is only visual, and values in the indicator buffer are stored without the shift. When obtaining buffer values using the CopyBuffer() function,the shift value will have no effect.

teeth_period

[in] Averaging period for the red line (Alligator's Teeth).

teeth_shift

[in] The shift of the red line relative to the price chart. It should be remembered that the line shift is only visual, and values in the indicator buffer are stored without the shift. When obtaining buffer values using the CopyBuffer() function,the shift value will have no effect.

lips_period

[in] Averaging period for the green line (Alligator's lips).

lips_shift

[in] The shift of the green line relative to the price chart. It should be remembered that the line shift is only visual, and values in the indicator buffer are stored without the shift. When obtaining buffer values using the CopyBuffer() function,the shift value will have no effect.

ma_method

[in] The method of averaging. Can be any of the ENUM_MA_METHOD values.

applied_price

[in] The price used. Can be any of the price constants ENUM_APPLIED_PRICE or a handle of another indicator.

Returned value

Returns the handle of a specified technical indicator, in case of failure returns INVALID_HANDLE. The computer memory can be freed from an indicator that is no more utilized, using the IndicatorRelease() function, to which the indicator handle is passed.

Note

The buffer numbers are the following: 0 - GATORJAW_LINE, 1 - GATORTEETH_LINE, 2 - GATORLIPS_LINE.

iADXWilder

iAMA