Class SwipeEvent

Class that represents the gesture events.

Export

Hierarchy-Diagram

UML class diagram of SwipeEvent

Legend

icon for a class in the UML class diagram

class

icon for an abstract class in the UML class diagram

abstract class

icon for a private property in the UML class diagram

private property

icon for a public method in the UML class diagram

public method

icon for a protected method in the UML class diagram

protected method

icon for a private method in the UML class diagram

private method

italic abstract property/method

Hierarchy

AbstractGestureEvent
- SwipeEvent

Index

Methods

setCallbacks setEventListeners unsetTouchEvents _onGestureEnd setSwipeCallbacks setSwipeEvents

Accessors

Properties

_swipeDownCallback _swipeLeftCallback _swipeRightCallback _swipeUpCallback _threshold _velocity

Constructors

Methods

`Protected` setCallbacks

setCallbacks(onStartCallback?: Generic, onMoveCallback?: Generic, onEndCallback?: Generic): void
Protected
Method to set the callbacks

Memberof
OSFramework.Event.GestureEvent.AbstractGestureEvent
Parameters
- Optional onStartCallback: Generic
- Optional onMoveCallback: Generic
- Optional onEndCallback: Generic
Returns void
Inherited from AbstractGestureEvent.setCallbacks
- Defined in OSFramework/Event/GestureEvents/AbstractGestureEvent.ts:129

`Protected` setEventListeners

setEventListeners(): void
Protected
Method to add the event listeners to the targetElement, with the expected callbacks

Memberof
OSFramework.Event.GestureEvent.AbstractGestureEvent

Returns void
Inherited from AbstractGestureEvent.setEventListeners
- Defined in OSFramework/Event/GestureEvents/AbstractGestureEvent.ts:149

unsetTouchEvents

unsetTouchEvents(): void
Method to remove the event listeners added to the targetElement and unset the callback

Memberof
OSFramework.Event.GestureEvent.AbstractGestureEvent

Returns void
Inherited from AbstractGestureEvent.unsetTouchEvents
- Defined in OSFramework/Event/GestureEvents/AbstractGestureEvent.ts:173

`Private` _onGestureEnd

_onGestureEnd(offsetX: number, offsetY: number, timeTaken: number): void
Private
Method to set on GestureEnd callback, as this one needs an exception to detect the final direction swiped

Memberof
OSFramework.Event.GestureEvent.SwipeEvent
Parameters
- offsetX: number
- offsetY: number
- timeTaken: number
Returns void
- Defined in OSFramework/Event/GestureEvents/SwipeEvent.ts:35

`Protected` setSwipeCallbacks

setSwipeCallbacks(swipeDownCallback: Generic, swipeLeftCallback: Generic, swipeRightCallback: Generic, swipeUpCallback: Generic): void
Protected
Method to set the expected callbacks

Memberof
OSFramework.Event.GestureEvent.SwipeEvent
Parameters
- swipeDownCallback: Generic
- swipeLeftCallback: Generic
- swipeRightCallback: Generic
- swipeUpCallback: Generic
Returns void
- Defined in OSFramework/Event/GestureEvents/SwipeEvent.ts:70

setSwipeEvents

setSwipeEvents(swipeDownCallback: SwipeDown, swipeLeftCallback: SwipeLeft, swipeRightCallback: SwipeRight, swipeUpCallback: SwipeUp): void
Method to set the expected callbacks and add eventListeners to the target element

Memberof
OSFramework.Event.GestureEvent.SwipeEvent
Parameters
- swipeDownCallback: SwipeDown
- swipeLeftCallback: SwipeLeft
- swipeRightCallback: SwipeRight
- swipeUpCallback: SwipeUp
Returns void
Overrides AbstractGestureEvent.setSwipeEvents
- Defined in OSFramework/Event/GestureEvents/SwipeEvent.ts:93

Accessors

targetElement

get targetElement(): HTMLElement
Get the targetElement

Memberof
OSFramework.Event.GestureEvent.AbstractGestureEvent

Returns HTMLElement
Inherited from Event.GestureEvent.AbstractGestureEvent.targetElement
- Defined in OSFramework/Event/GestureEvents/AbstractGestureEvent.ts:164

Properties

`Private` _swipeDownCallback

_swipeDownCallback: Generic

`Private` _swipeLeftCallback

_swipeLeftCallback: Generic

`Private` _swipeRightCallback

_swipeRightCallback: Generic

`Private` _swipeUpCallback

_swipeUpCallback: Generic

`Private` _threshold

_threshold: number = 10

`Private` _velocity

_velocity: number = 0.3

Constructors

constructor

new SwipeEvent(target: HTMLElement): SwipeEvent
Parameters
- target: HTMLElement
Returns SwipeEvent
Overrides AbstractGestureEvent.constructor
- Defined in OSFramework/Event/GestureEvents/SwipeEvent.ts:22