Class TrackGesture

This is a simple wrapper around the GestureWatcher. If you are using the JavaScript API, you should use the GestureWatcher directly. The purpose of this widget is to expose the watcher's ability to track gestures and set relevant CSS properties via the HTML API. See GestureWatcher.trackGesture.

To use with auto-widgets (HTML API) (see settings.autoWidgets), the following CSS classes or data attributes are recognized:

  • lisn-track-gesture class or data-lisn-track-gesture attribute set on the element that constitutes the widget.

See below examples for what values you can use set for the data attributes in order to modify the configuration of the automatically created widget.

Example

This will track user gestures over this element and set the relevant CSS properties. It will use the default GestureWatcher options.

<div class="lisn-track-gesture"></div>

Example

As above but with custom settings.

<div data-lisn-track-gesture="prevent-default=false
                              | min-delta-x=-100
                              | max-delta-x=100
                              | min-delta-y=-100
                              | max-delta-y=100
                              | min-delta-z=0.5
                              | max-delta-z=2"
></div>

Hierarchy (View Summary)

Methods

get register

Constructors

constructor

Properties

destroy disable enable getElement isDestroyed isDisabled onDestroy onDisable onEnable toggleEnable

Methods

Staticget

Staticregister

Constructors

constructor

Properties

Readonlydestroy

destroy: () => Promise<void>

Undoes all modifications to the element and returns it to its original state.

You will need to recreate it if you want to enable its functionality again.

Readonlydisable

disable: () => Promise<void>

Disables the functionality of the widget. What this means is specific to each widget.

Readonlyenable

enable: () => Promise<void>

Re-enables the functionality of the widget. What this means is specific to each widget.

ReadonlygetElement

getElement: () => Element

Returns the element passed to the widget constructor.

ReadonlyisDestroyed

isDestroyed: () => boolean

Returns true if the widget is destroyed.

ReadonlyisDisabled

isDisabled: () => boolean

Returns true if the widget is currently disabled.

ReadonlyonDestroy

onDestroy: (handler: WidgetHandler) => void

The given handler will be called when the widget is destroyed.

ReadonlyonDisable

onDisable: (handler: WidgetHandler) => void

The given handler will be called when the widget is disabled.

ReadonlyonEnable

onEnable: (handler: WidgetHandler) => void

The given handler will be called when the widget is enabled.

ReadonlytoggleEnable

toggleEnable: () => Promise<void>

Re-enables the widget if disabled, otherwise disables it.

Settings

Member Visibility

On This Page

Methods
Constructors
Properties