Class FlatTopBottom

Draws a line between two points and another horizontal line above or below it. The area between the lines is then colored.

Hierarchy

Constructors

constructor

Methods

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

Constructors

constructor

  • Parameters

    • priceChart: TradingChart
    • chart: ChartXY<UIBackground>
    • closeValues: number[]
    • startPoint: Point
    • endPoint: Point
    • flatYValue: number
    • lineColor: Color
    • lineWidth: number
    • areaColor: Color

    Returns FlatTopBottom

Methods

dispose

getPosition

  • Gets the current drawing tool position in axis values.

    Returns Point[]

    • Array containing all control point positions (diagonal start, diagonal end, flat start, flat end).

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 'startX', 'endX', 'trendStartY', 'trendEndY' and 'flatY' parameters indicating the drawing tool's new position.

    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

setAreaColor

  • Sets the color of the area between the lines.

    Parameters

    • newColor: string

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

    Returns void

setExtendLines

  • Sets whether the two lines extend to the edge of the chart.

    Parameters

    • extendLines: boolean

      Set true to extend the lines.

    Returns void

setFillEnabled

  • Sets whether the area between the two lines is colored or not. Use setAreaColor() to set the color for the area.

    Parameters

    • fillEnabled: boolean

      Set true to enable colored fill.

    Returns void

setLineColor

  • Sets the color of the 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 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

updatePosition

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

    Parameters

    • startX: number

      Trend line first point X-location.

    • endX: number

      Trend line second point X-location.

    • trendStartY: number

      Trend line first point Y-location.

    • trendEndY: number

      Trend line second point Y-location.

    • flatY: number

      Flat line Y-location.

    Returns void

Settings

Member Visibility

Theme