Gesto

Extends

• EventEmitter

Methods

emit(eventName, paramopt) → {boolean}

Source:

• node_modules/@scena/event-emitter/src/EventEmitter.ts, line 134

Overrides:

• EventEmitter#emit

emit<Name extends keyof Events, Param = Events[Name]>(eventName) → {boolean}

emit<Name extends keyof Events, Param = Events[Name]>(eventName, param) → {boolean}

Example

import EventEmitter from "@scena/event-emitter";


const emitter = new EventEmitter();

emitter.on("a", e => {
});


emitter.emit("a", {
  a: 1,
});

Returns:

Type

boolean

getCurrentEvent(inputEventopt)

Source:

• src/Gesto.ts, line 213

getEventData()

Source:

• src/Gesto.ts, line 228

getEventDatas()

Source:

• src/Gesto.ts, line 236

getMovement(clientsopt)

Source:

• src/Gesto.ts, line 117

isDoubleFlag()

Source:

• src/Gesto.ts, line 149

isDragging() → {boolean}

Source:

• src/Gesto.ts, line 125

Returns:

Type

boolean

isFlag() → {boolean}

Source:

• src/Gesto.ts, line 137

Returns:

Type

boolean

isIdle() → {boolean}

Source:

• src/Gesto.ts, line 131

Returns:

Type

boolean

isPinchFlag()

Source:

• src/Gesto.ts, line 143

isPinching()

Source:

• src/Gesto.ts, line 155

move(inputEvent) → {TargetParam<OnDrag>}

Source:

• src/Gesto.ts, line 172

Returns:

Type

TargetParam<OnDrag>

off(eventNameopt, listeneropt) → {this}

Source:

• node_modules/@scena/event-emitter/src/EventEmitter.ts, line 63

Overrides:

• EventEmitter#off

off<Name extends keyof Events, Param = Events[Name]>(eventName, listener) → {this}

off(events) → {this}

Example

import EventEmitter from "@scena/event-emitter";
cosnt emitter = new EventEmitter();

// Remove all listeners.
emitter.off();

// Remove all listeners in "A" event.
emitter.off("a");


// Remove "listener" listener in "a" event.
emitter.off("a", listener);

Returns:

Type

this

on(eventName, listeneropt) → {this}

Source:

• node_modules/@scena/event-emitter/src/EventEmitter.ts, line 32

Overrides:

• EventEmitter#on

on<Name extends keyof Events, Param = Events[Name]>(eventName, listener) → {this}

on(events) → {this}

Example

import EventEmitter from "@scena/event-emitter";
cosnt emitter = new EventEmitter();

// Add listener in "a" event
emitter.on("a", () => {
});
// Add listeners
emitter.on({
 a: () => {},
 b: () => {},
});

Returns:

Type

this

once<Name extends keyof Events & string, Param = Events[Name]>(eventName, listeneropt) → {Promise<OnEvent<Param, this>>}

Source:

• node_modules/@scena/event-emitter/src/EventEmitter.ts, line 101

Overrides:

• EventEmitter#once

Example

import EventEmitter from "@scena/event-emitter";
cosnt emitter = new EventEmitter();

// Add a disposable listener in "a" event
emitter.once("a", () => {
});

// Use Promise
emitter.once("a").then(e => {
});

Returns:

Type

Promise<OnEvent<Param, this>>

scrollBy(deltaX, deltaY, e, isCallDragopt)

Source:

• src/Gesto.ts, line 162

setEventData(data)

Source:

• src/Gesto.ts, line 194

setEventDatas(data)

Source:

• src/Gesto.ts, line 207

Deprecated:

• Yes

stop()

Source:

• src/Gesto.ts, line 100

trigger<Name extends keyof Events>(eventName, paramopt) → {boolean}

Source:

• node_modules/@scena/event-emitter/src/EventEmitter.ts, line 199

Overrides:

• EventEmitter#trigger

trigger<Name extends keyof Events, Param = Events[Name]>(eventName) → {boolean}

trigger<Name extends keyof Events, Param = Events[Name]>(eventName, param) → {boolean}

Example

import EventEmitter from "@scena/event-emitter";


const emitter = new EventEmitter();

emitter.on("a", e => {
});


emitter.emit("a", {
  a: 1,
});
     

Returns:

Type

boolean

triggerDragStart(e)

Source:

• src/Gesto.ts, line 188

unset()

Source:

• src/Gesto.ts, line 242

Type Definitions

Client

Source:

• src/types.ts, line 8

Properties:

Type:

• TSInterface

Delta

Source:

• src/types.ts, line 26

Properties:

Type:

• TSInterface

Dist

Source:

• src/types.ts, line 18

Properties:

Type:

• TSInterface

GestoEvents

Source:

• src/types.ts, line 205

Type:

• {"dragStart": OnDragStart, "drag": OnDrag, "dragEnd": OnDragEnd, "pinchStart": OnPinchStart, "pinch": OnPinch, "pinchEnd": OnPinchEnd}

GestoOptions

Source:

• src/types.ts, line 143

Properties:

Type:

• TSInterface

OnDrag<T = Gesto>

Source:

• src/types.ts, line 61

Properties:

Type:

• TSInterface

OnDragEnd<T = Gesto>

Source:

• src/types.ts, line 80

Properties:

Type:

• TSInterface

OnDragStart<T = Gesto>

Source:

• src/types.ts, line 44

Properties:

Type:

• TSInterface

OnPinch<T = Gesto>

Source:

• src/types.ts, line 113

Properties:

Type:

• TSInterface

OnPinchEnd<T = Gesto>

Source:

• src/types.ts, line 131

Properties:

Type:

• TSInterface

OnPinchStart<T = Gesto>

Source:

• src/types.ts, line 97

Properties:

Type:

• TSInterface

Position

Source:

• src/types.ts, line 37

Properties:

Type:

• TSInterface