Class SwipeEvent

Class that represents the gesture events.

Export

Hierarchy-Diagram

Legend

class

abstract class

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractGestureEvent
- SwipeEvent

Index

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/OSUI/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/OSUI/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/OSUI/Event/GestureEvents/AbstractGestureEvent.ts:173

`Private` _onGestureEnd

_onGestureEnd(offsetX: number, offsetY: number, timeTaken: number): void
Parameters
- offsetX: number
- offsetY: number
- timeTaken: number
Returns void
- Defined in OSFramework/OSUI/Event/GestureEvents/SwipeEvent.ts:27

`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/OSUI/Event/GestureEvents/SwipeEvent.ts:62

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/OSUI/Event/GestureEvents/SwipeEvent.ts:85

Accessors

targetElement

get targetElement(): HTMLElement
Get the targetElement

Memberof
OSFramework.Event.GestureEvent.AbstractGestureEvent

Returns HTMLElement
Inherited from AbstractGestureEvent.targetElement
- Defined in OSFramework/OSUI/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/OSUI/Event/GestureEvents/SwipeEvent.ts:22

Class SwipeEvent

Export

Hierarchy-Diagram

Legend

Hierarchy

Index

Methods

Accessors

Properties

Constructors

Methods

Protected setCallbacks

Memberof

Parameters

Optional onStartCallback: Generic

Optional onMoveCallback: Generic

Optional onEndCallback: Generic

Returns void

Protected setEventListeners

Memberof

Returns void

unsetTouchEvents

Memberof

Returns void

Private _onGestureEnd

Parameters

offsetX: number

offsetY: number

timeTaken: number

Returns void

Protected setSwipeCallbacks

Memberof

Parameters

swipeDownCallback: Generic

swipeLeftCallback: Generic

swipeRightCallback: Generic

swipeUpCallback: Generic

Returns void

setSwipeEvents

Memberof

Parameters

swipeDownCallback: SwipeDown

swipeLeftCallback: SwipeLeft

swipeRightCallback: SwipeRight

swipeUpCallback: SwipeUp

Returns void

Accessors

targetElement

Memberof

Returns HTMLElement

Properties

Private _swipeDownCallback

Private _swipeLeftCallback

Private _swipeRightCallback

Private _swipeUpCallback

Private _threshold

Private _velocity

Constructors

constructor

Parameters

target: HTMLElement

Returns SwipeEvent

Settings

Member Visibility

Theme

`Protected` setCallbacks

`Optional` onStartCallback: Generic

`Optional` onMoveCallback: Generic

`Optional` onEndCallback: Generic

`Protected` setEventListeners

`Private` _onGestureEnd

`Protected` setSwipeCallbacks

`Private` _swipeDownCallback

`Private` _swipeLeftCallback

`Private` _swipeRightCallback

`Private` _swipeUpCallback

`Private` _threshold

`Private` _velocity