Class ElliotWave

Draws a wave pattern between several control points.

Hierarchy

Constructors

constructor

Methods

dispose getPosition offDrawingToolMoved offPointerDown offPointerEnter offPointerLeave offPointerUp onDrawingToolMoved onPointerDown onPointerEnter onPointerLeave onPointerUp setLineColor setLineWidth setMagnetic setWaveType updatePosition

Constructors

constructor

  • Parameters

    • priceChart: TradingChart
    • chart: ChartXY<UIBackground>
    • closeValues: number[]
    • startPoint: Point
    • secondPoint: Point
    • thirdPoint: Point
    • fourthPoint: Point
    • fifthPoint: Point
    • sixthPoint: Point
    • seventhPoint: Point
    • eighthPoint: Point
    • ninthPoint: Point
    • lineColor: Color
    • lineWidth: number
    • waveType: ElliotWaveType

    Returns ElliotWave

Methods

dispose

getPosition

  • Gets the current drawing tool position in axis values.

    Returns Point[]

    • Array containing all control point positions.

offDrawingToolMoved

  • Unsubscribes from the DrawingToolMoved event.

    Returns void

offPointerDown

  • Unsubscribes from the PointerDown event.

    Returns void

offPointerEnter

  • Unsubscribes from the PointerEnter event.

    Returns void

offPointerLeave

  • Unsubscribes from the PointerLeave event.

    Returns void

offPointerUp

  • Unsubscribes from the PointerUp event.

    Returns void

onDrawingToolMoved

  • Event that triggers when drawing tool's position has been changed either by dragging it or in code.

    Parameters

    • handler: Handler<DrawingToolMovedEvent>

      Event handler containing X- and Y-position parameters for each of the control points.

    Returns void

onPointerDown

  • Event that triggers when pointer is pressed down on top of the drawing tool.

    Parameters

    • handler: Handler<PointerDownEvent>

      Event handler containing the following parameters:

      -'xPosition' and 'yPosition' parameters return the current cursor position in axis values.

      -'xPositionClient' and 'yPositionClient' return the current cursor position in client coordinates (zero equals top-left corner).

      -'drawingTool' gets the drawing tool instance.

      -'isControlPoint' tells if the event was triggered by one of the drawing tool's control points.

      -'button' indicates the pressed mouse button.

    Returns void

onPointerEnter

  • Event that triggers when pointer is moved onto the drawing tool.

    Parameters

    • handler: Handler<PointerEnterEvent>

      Event handler containing the following parameters:

      -'xPosition' and 'yPosition' parameters return the current cursor position in axis values.

      -'xPositionClient' and 'yPositionClient' return the current cursor position in client coordinates (zero equals top-left corner).

      -'drawingTool' gets the drawing tool instance.

      -'isControlPoint' tells if the event was triggered by one of the drawing tool's control points.

    Returns void

onPointerLeave

  • Event that triggers when pointer is moved away from the drawing tool.

    Parameters

    • handler: Handler<PointerLeaveEvent>

      Event handler containing the following parameters:

      -'xPosition' and 'yPosition' parameters return the current cursor position in axis values.

      -'xPositionClient' and 'yPositionClient' return the current cursor position in client coordinates (zero equals top-left corner).

      -'drawingTool' gets the drawing tool instance.

      -'isControlPoint' tells if the event was triggered by one of the drawing tool's control points.

    Returns void

onPointerUp

  • Event that triggers when pointer is released on top of the drawing tool.

    Parameters

    • handler: Handler<PointerUpEvent>

      Event handler containing the following parameters:

      -'xPosition' and 'yPosition' parameters return the current cursor position in axis values.

      -'xPositionClient' and 'yPositionClient' return the current cursor position in client coordinates (zero equals top-left corner).

      -'drawingTool' gets the drawing tool instance.

      -'isControlPoint' tells if the event was triggered by one of the drawing tool's control points.

      -'button' indicates the released mouse button.

    Returns void

setLineColor

  • Sets the line color of the wave lines.

    Parameters

    • newColor: string

      New line color as string, should be in HEX format e.g. #FFFFFF.

    Returns void

setLineWidth

  • Sets the width of the wave lines.

    Parameters

    • newWidth: number

      New line width.

    Returns void

setMagnetic

  • Sets whether the drawing tool should automatically snap to OLHC-data points.

    Parameters

    • isMagnetic: boolean

      Set true to enable snapping to data points.

    Returns void

setWaveType

  • Sets the type of the Elliot Wave.

    Parameters

    Returns void

updatePosition

  • Updates the drawing tool based on the control points' locations.

    Parameters

    • startPosition: Point = ...

      First control point location.

    • position1: Point = ...

      Second control point location (1).

    • position2: Point = ...

      Third control point location (2).

    • position3: Point = ...

      Fourth control point location (3).

    • position4: Point = ...

      Fifth control point location (4).

    • position5: Point = ...

      Sixth control point location (5).

    • positionA: Point = ...

      Seventh control point location (A).

    • positionB: Point = ...

      Eighth control point location (B).

    • positionC: Point = ...

      Ninth control point location (C).

    Returns void

Settings

Member Visibility

Theme