Skip to content
This is the alpha v4 version website. Looking for the v3 documentation?

TouchCaptor

Defined in: packages/sigma/src/core/captors/touch.ts:44

Touch captor class.

Extends

  • default<TouchCaptorEvents, N, E, G>

Type Parameters

N

N extends Attributes = Attributes

E

E extends Attributes = Attributes

G

G extends Attributes = Attributes

Constructors

Constructor

new TouchCaptor<N, E, G>(container, renderer): TouchCaptor<N, E, G>

Defined in: packages/sigma/src/core/captors/touch.ts:67

Parameters

container

HTMLElement

renderer

Sigma<N, E, G>

Returns

TouchCaptor<N, E, G>

Overrides

Captor<TouchCaptorEvents, N, E, G>.constructor

Properties

container

container: HTMLElement

Defined in: packages/sigma/src/core/captors/captor.ts:142

Inherited from

Captor.container


enabled

enabled: boolean = true

Defined in: packages/sigma/src/core/captors/touch.ts:49


hasMoved

hasMoved: boolean = false

Defined in: packages/sigma/src/core/captors/touch.ts:51


isMoving

isMoving: boolean = false

Defined in: packages/sigma/src/core/captors/touch.ts:50


isPanningStage

isPanningStage: boolean = false

Defined in: packages/sigma/src/core/captors/touch.ts:52


isZoomingStage

isZoomingStage: boolean = false

Defined in: packages/sigma/src/core/captors/touch.ts:53


lastTap

lastTap: { position: Coordinates; time: number; } | null = null

Defined in: packages/sigma/src/core/captors/touch.ts:63


lastTouches

lastTouches: Touch[] = []

Defined in: packages/sigma/src/core/captors/touch.ts:62


lastTouchesPositions?

optional lastTouchesPositions?: Coordinates[]

Defined in: packages/sigma/src/core/captors/touch.ts:61


movingTimeout?

optional movingTimeout?: number

Defined in: packages/sigma/src/core/captors/touch.ts:56


rawEmitter

rawEmitter: EventEmitter

Defined in: packages/sigma/src/types.ts:232

Inherited from

Captor.rawEmitter


renderer

renderer: Sigma<N, E, G>

Defined in: packages/sigma/src/core/captors/captor.ts:143

Inherited from

Captor.renderer


settings

settings: TouchSettings = DEFAULT_TOUCH_SETTINGS

Defined in: packages/sigma/src/core/captors/touch.ts:65


startCameraState?

optional startCameraState?: CameraState

Defined in: packages/sigma/src/core/captors/touch.ts:54


startTouchesAngle?

optional startTouchesAngle?: number

Defined in: packages/sigma/src/core/captors/touch.ts:58


startTouchesDistance?

optional startTouchesDistance?: number

Defined in: packages/sigma/src/core/captors/touch.ts:59


startTouchesPositions

startTouchesPositions: Coordinates[] = []

Defined in: packages/sigma/src/core/captors/touch.ts:60


touchMode

touchMode: number = 0

Defined in: packages/sigma/src/core/captors/touch.ts:55

Methods

addListener()

addListener<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:238

Type Parameters

Event

Event extends TouchCaptorEventType

Parameters

type

Event

listener

TouchCaptorEvents[Event]

Returns

this

Inherited from

Captor.addListener


emit()

emit<Event>(type, …args): boolean

Defined in: packages/sigma/src/types.ts:237

Type Parameters

Event

Event extends TouchCaptorEventType

Parameters

type

Event

args

Parameters<TouchCaptorEvents[Event]>

Returns

boolean

Inherited from

Captor.emit


eventNames()

eventNames<Event>(): Event[]

Defined in: packages/sigma/src/types.ts:234

Type Parameters

Event

Event extends TouchCaptorEventType

Returns

Event[]

Inherited from

Captor.eventNames


getDimensions()

getDimensions(): Dimensions

Defined in: packages/sigma/src/core/captors/touch.ts:91

Returns

Dimensions


getMaxListeners()

getMaxListeners(): number

Defined in: packages/sigma/src/types.ts:236

Returns

number

Inherited from

Captor.getMaxListeners


handleLeave()

handleLeave(e): void

Defined in: packages/sigma/src/core/captors/touch.ts:139

Parameters

e

TouchEvent

Returns

void


handleMove()

handleMove(e): void

Defined in: packages/sigma/src/core/captors/touch.ts:224

Parameters

e

TouchEvent

Returns

void


handleStart()

handleStart(e): void

Defined in: packages/sigma/src/core/captors/touch.ts:114

Parameters

e

TouchEvent

Returns

void


kill()

kill(): void

Defined in: packages/sigma/src/core/captors/touch.ts:82

Returns

void

Overrides

Captor.kill


listenerCount()

listenerCount<Event>(type): number

Defined in: packages/sigma/src/types.ts:247

Type Parameters

Event

Event extends TouchCaptorEventType

Parameters

type

Event

Returns

number

Inherited from

Captor.listenerCount


listeners()

listeners<Event>(type): TouchCaptorEvents[Event][]

Defined in: packages/sigma/src/types.ts:246

Type Parameters

Event

Event extends TouchCaptorEventType

Parameters

type

Event

Returns

TouchCaptorEvents[Event][]

Inherited from

Captor.listeners


off()

off<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:244

Type Parameters

Event

Event extends TouchCaptorEventType

Parameters

type

Event

listener

TouchCaptorEvents[Event]

Returns

this

Inherited from

Captor.off


on()

on<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:239

Type Parameters

Event

Event extends TouchCaptorEventType

Parameters

type

Event

listener

TouchCaptorEvents[Event]

Returns

this

Inherited from

Captor.on


once()

once<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:240

Type Parameters

Event

Event extends TouchCaptorEventType

Parameters

type

Event

listener

TouchCaptorEvents[Event]

Returns

this

Inherited from

Captor.once


prependListener()

prependListener<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:241

Type Parameters

Event

Event extends TouchCaptorEventType

Parameters

type

Event

listener

TouchCaptorEvents[Event]

Returns

this

Inherited from

Captor.prependListener


prependOnceListener()

prependOnceListener<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:242

Type Parameters

Event

Event extends TouchCaptorEventType

Parameters

type

Event

listener

TouchCaptorEvents[Event]

Returns

this

Inherited from

Captor.prependOnceListener


rawListeners()

rawListeners<Event>(type): TouchCaptorEvents[Event][]

Defined in: packages/sigma/src/types.ts:248

Type Parameters

Event

Event extends TouchCaptorEventType

Parameters

type

Event

Returns

TouchCaptorEvents[Event][]

Inherited from

Captor.rawListeners


removeAllListeners()

removeAllListeners<Event>(type?): this

Defined in: packages/sigma/src/types.ts:245

Type Parameters

Event

Event extends TouchCaptorEventType

Parameters

type?

Event

Returns

this

Inherited from

Captor.removeAllListeners


removeListener()

removeListener<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:243

Type Parameters

Event

Event extends TouchCaptorEventType

Parameters

type

Event

listener

TouchCaptorEvents[Event]

Returns

this

Inherited from

Captor.removeListener


setMaxListeners()

setMaxListeners(n): this

Defined in: packages/sigma/src/types.ts:235

Parameters

n

number

Returns

this

Inherited from

Captor.setMaxListeners


setSettings()

setSettings(settings): void

Defined in: packages/sigma/src/core/captors/touch.ts:342

Parameters

settings

TouchSettings

Returns

void