Options
All
  • Public
  • Public/Protected
  • All
Menu

An enumeration describing GestureEventType

Overview

Enumeration members

CONTEXT_MENU

CONTEXT_MENU: = 14

Used when a context menu should be shown. GestureEvent.domEvent returns the up event that triggered this gesture event.

DOUBLE_CLICK

DOUBLE_CLICK: = 1

Used when a double-tap occurs. GestureEvent.domEvent returns the down DOM event of the first tap of the double-tap.

DOUBLE_CLICK_EVENT

DOUBLE_CLICK_EVENT: = 2

Used when an event within a double-tap gesture occurs, including the down, move, and up events. GestureEvent.domEvent returns the DOM event that occurred during the double-tap gesture.

DOWN

DOWN: = 3

Used when a tap occurs. This will be triggered immediately for every down event. All other events should be preceded by this. GestureEvent.domEvent returns the down DOM event that triggered this gesture event.

DRAG

DRAG: = 6

Used when a drag occurs. When it occurs, GestureEvent.domEvent returns the move event that triggered this gesture event. The drag event additionally contains a downEvent property which contains a copy of the last down event that preceded the drag event. This can be used to determine where the drag event started.

DRAG_END

DRAG_END: = 7

Used when a drag gesture ends. When it occurs, GestureEvent.domEvent returns the up event that triggered this gesture event.

LONG_PRESS

LONG_PRESS: = 5

Used when a long press occurs. GestureEvent.domEvent returns the down event that started the long press.

MOVE

MOVE: = 12

Used when a move event occurs that is not considered a drag. When it occurs, GestureEvent.domEvent returns the move event that triggered this gesture event.

PINCH

PINCH: = 11

Used when a pinch event occurs. The GestureEvent.domEvent returns the dom event that triggered the current pinch event. The pinch event additionally contains a scaleFactor property which indicates whether the fingers are progressing towards each other (<1) or away from each other (>1). scaleFactor is defined as the ratio of the current span (distance between fingers) to the previous span. The pinch event also has a scaleFactorFromStart property, which is defined as the ratio of the current span to the span at the start of the pinch.

PINCH_END

PINCH_END: = 19

Used when a pinch event ends.

ROTATE

ROTATE: = 17

Used when performing a 'turn' or rotation gesture with touch. When it occurs, GestureEvent.domEvent returns the touch event that triggered this gesture event. Its clientPosition, viewPosition and pagePosition properties refer to the center between the two fingers, at the start of the twist. The event contains an additional property angle that refers to the current angle between the two fingers. It is defined as the angle between the horizontal of the screen and the line connecting the two fingers. It is measured in degrees and counter-clockwise positive. An angle of 0 refers to the position where the first finger is located to the left (west, left on the screen) of the other finger. An additional span property refers to the current distance between the two fingers, measured in pixels.

ROTATE_END

ROTATE_END: = 18

Used when performing a 'turn' or rotation gesture with touch ends.

SCROLL

SCROLL: = 4

Used for a mouse wheel scroll events. When it occurs, GestureEvent.domEvent returns the scroll event that triggered this gesture event. An event of this type also contains an amount property that indicates how large the scroll event was. The value of the amount property is positive if the scroll direction is upwards, negative otherwise.

SHOW_PRESS

SHOW_PRESS: = 8

Used when the user has performed a down DOM event and not performed a move or up yet. This event is commonly used to provide visual feedback to the user to let them know that their action has been recognized i.e. highlight an element. GestureEvent.domEvent returns the down motion event.

SINGLE_CLICK_CONFIRMED

SINGLE_CLICK_CONFIRMED: = 9

Used when a single-tap occurs. Unlike SINGLE_CLICK_UP, this gesture will only be used after the detector is confident that the user's first tap is not followed by a second tap leading to a double-click gesture. GestureEvent.domEvent returns the down DOM event of the single-click.

SINGLE_CLICK_UP

SINGLE_CLICK_UP: = 10

Used when a click occurs. GestureEvent.domEvent returns the up DOM event that completed the first tap.

TWO_FINGER_DRAG

TWO_FINGER_DRAG: = 15

Used when dragging with 2 fingers in the same direction. When it occurs, GestureEvent.domEvent returns the touch event that triggered this gesture event. Its clientPosition, viewPosition and pagePosition properties refer to the current center between the two fingers.

TWO_FINGER_DRAG_END

TWO_FINGER_DRAG_END: = 16

Used when scrolling with 2 fingers in the same direction ends.

UP

UP: = 13

Used when an up event occurs. When it occurs, GestureEvent.domEvent returns the up event that triggered this gesture event.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method