Waves

1. Sept.

Library "Waves"
Methods for elliot wave detection

method delete(this)
  deletes the subwave drawing
  Namespace types: Subwave
  Parameters:
    this (Subwave): Subwave object to be deleted
  Returns: deleted subwave object

method delete(this)
  deletes the wave drawing and the corresponding subwaves
  Namespace types: Wave
  Parameters:
    this (Wave): Wave object to be deleted
  Returns: deleted wave object

method createWave(pivot, lineColor, waves, limit)
  Create wave object
  Namespace types: zg.Pivot
  Parameters:
    pivot (Pivot type from Trendoscope/Zigzag/7): pivot object where the wave needs to be created
    lineColor (color): color of the wave to be drawn
    waves (array<Wave>): array of existing waves
    limit (int): max number of waves to be shown in the chart
  Returns: wave object created

method createSubWaves(wave, subwavePivots)
  Create sub waves for the wave
  Namespace types: Wave
  Parameters:
    wave (Wave)
    subwavePivots (array<SubwavePivots>): array of sub wave pivots
  Returns: wave object created

method draw(subWave)
  Draw subwave
  Namespace types: Subwave
  Parameters:
    subWave (Subwave)
  Returns: subwsubWave object

method draw(wave, limitSubwaves)
  Draw Wave
  Namespace types: Wave
  Parameters:
    wave (Wave): Wave object to be drawn
    limitSubwaves (bool): limit the number of subwave combinations within the wave
  Returns: wave object

method checkMotiveWave(prices)
  based on the price array, check if there is motive wave and identify the type
  Namespace types: array<float>
  Parameters:
    prices (array<float>): float array of prices
  Returns: WaveType representing the identified wave type. na otherwise

method scanMotiveWave(pivot, lastPivot, existingWaves, allowedTypes)
  Scan for motive wave
  Namespace types: zg.Pivot
  Parameters:
    pivot (Pivot type from Trendoscope/Zigzag/7): Zigzag pivot that will be checked for motive wave
    lastPivot (Pivot type from Trendoscope/Zigzag/7): previous Zigzag pivot
    existingWaves (array<Wave>): array of existing waves
    allowedTypes (array<WaveType>): allowed Wave types to filter them
  Returns: array of subwave pivots

SubwavePivots
  SubwavePivots represents the sub pivots of the main wave
  Fields:
    waveType (series WaveType): Type of the Wave
    indices (array<int>): Bar index values of sub waves
    subPivots (array<Pivot> type from Trendoscope/Zigzag/7): sub pivot objects of the wave

Subwave
  Subwave represents the drawing of sub waves
  Fields:
    waves (array<Line> type from Trendoscope/Drawing/1): array of sub wave lines
    points (array<Label> type from Trendoscope/Drawing/1): Array of subwave pivot labels
    subwavePivots (SubwavePivots): array of subwave pivots being drawn

Wave
  Wave object type
  Fields:
    pivot (Pivot type from Trendoscope/Zigzag/7): starting point of the wave
    wave (Line type from Trendoscope/Drawing/1): Line representing the wave
    waveLabel (Label type from Trendoscope/Drawing/1): label containing wave details
    subWaves (array<Subwave>): array of sub waves