Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClickDetector

Click detector creation payload typehints

typedef

{{ consumeEvents?: boolean, preventDefault?: boolean, applyCssClass?: string, captureTouchmove?: boolean, targetOnly?: boolean, maxDistance?: number, clickSound?: string, trackAnalytics?: false|null|string }} ClickDetectorConstructorArgs

Hierarchy

  • ClickDetector

Index

Constructors

constructor

  • new ClickDetector(element: any, __namedParameters: object): ClickDetector
  • Parameters

    • element: any
    • __namedParameters: object
      • applyCssClass: string
      • captureTouchmove: boolean
      • clickSound: string
      • consumeEvents: boolean
      • maxDistance: number
      • preventDefault: boolean
      • targetOnly: boolean
      • trackAnalytics: boolean

    Returns ClickDetector

Methods

cancelOngoingEvents

  • cancelOngoingEvents(): void
  • Cacnels all ongoing events on this detector

    Returns void

cleanup

  • cleanup(): void
  • Cleans up all event listeners of this detector

    Returns void

internalBindTo

  • internalBindTo(element: any): void
  • Binds the click detector to an element

    Parameters

    • element: any

    Returns void

internalEventPreHandler

  • internalEventPreHandler(event: any, expectedRemainingTouches?: number): boolean
  • Checks if the given event is relevant for this detector

    Parameters

    • event: any
    • Default value expectedRemainingTouches: number = 1

    Returns boolean

internalGetEventListenerOptions

  • internalGetEventListenerOptions(): object
  • Internal method to get the options to pass to an event listener

    Returns object

    • capture: any
    • passive: boolean

internalIsDomElementAttached

  • internalIsDomElementAttached(): boolean
  • Returns if the bound element is currently in the DOM.

    Returns boolean

internalOnPointerDown

  • internalOnPointerDown(event: any): boolean
  • Internal pointer down handler

    Parameters

    • event: any

    Returns boolean

internalOnPointerEnd

  • internalOnPointerEnd(event: any): boolean
  • Internal pointer end handler

    Parameters

    • event: any

    Returns boolean

internalOnPointerMove

  • internalOnPointerMove(event: any): boolean
  • Internal pointer move handler

    Parameters

    • event: any

    Returns boolean

internalOnTouchCancel

  • internalOnTouchCancel(event: any): boolean
  • Internal touch cancel handler

    Parameters

    • event: any

    Returns boolean

Static extractPointerPosition

  • extractPointerPosition(event: any): Vector
  • Extracts the mous position from an event

    Parameters

    • event: any

    Returns Vector

    The client space position