9.0 Released! → Native ESM runtimes 🚀, Vite support ⚡️, multi-window apps and more...
Read Announcement

Defined in: ui/gestures/index.d.ts:11

Provides options for the GesturesObserver.

Constructors

Constructor

ts
new GesturesObserver(
   target: View, 
   callback: (args: GestureEventData) => void, 
   context: any): GesturesObserver;

Defined in: ui/gestures/index.d.ts:18

Creates an instance of GesturesObserver class.

Parameters

ParameterTypeDescription
targetViewThe view for which the observer is created.
callback(args: GestureEventData) => voidA function that will be executed when a gesture is received.
contextanydefault this argument for the callbacks.

Returns

GesturesObserver

Properties

androidOnTouchEvent

ts
androidOnTouchEvent: (motionEvent: any) => void;

Defined in: ui/gestures/index.d.ts:51

An internal Android specific method used to pass the motion event to the correct gesture observer.

Parameters

ParameterType
motionEventany

Returns

void


callback

ts
callback: (args: GestureEventData) => void;

Defined in: ui/gestures/index.d.ts:41

A function that will be executed when a gesture is received.

Parameters

ParameterType
argsGestureEventData

Returns

void


context

ts
context: any;

Defined in: ui/gestures/index.d.ts:46

A context which will be used as this in callback execution.


type

ts
type: GestureTypes;

Defined in: ui/gestures/index.d.ts:36

Singular gesture type (e.g. GestureTypes.tap) attached to the observer. Does not support plural gesture types (e.g. GestureTypes.tap & GestureTypes.doubleTap).

Methods

disconnect()

ts
disconnect(): any;

Defined in: ui/gestures/index.d.ts:29

Disconnects the gesture observer.

Returns

any


observe()

ts
observe(type: GestureTypes): any;

Defined in: ui/gestures/index.d.ts:24

Registers a gesture observer to a view and gesture.

Parameters

ParameterTypeDescription
typeGestureTypesType of the gesture.

Returns

any

Previous
Frame