Class DragHandler

Drag/pan event handler module. Handles pointer down/move/up events for panning the image.

Index

Constructors

Methods

hook start stop unhook

Constructors

constructor

new DragHandler(ctx: EventContext): DragHandler
Parameters
- ctx: EventContext
Returns DragHandler

Methods

hook

hook(): void
Hooks pointer down/move/up listeners for drag panning.

Returns void

start

start(e: PointerEvent, force?: boolean): void
Handles the start of a drag/pan operation (pointerdown).
Parameters
- e: PointerEvent
  The PointerEvent.
- force: boolean = false
  If true, forces drag start even if target isn't the canvas.
Returns void

stop

stop(e?: PointerEvent, noKinetic?: boolean, noDispatch?: boolean): void
Handles the end of a drag/pan operation (pointerup).
Parameters
- Optionale: PointerEvent
  Optional PointerEvent.
- noKinetic: boolean = false
  If true, prevents kinetic coasting animation.
- noDispatch: boolean = false
  If true, suppresses the 'panend' event.
Returns void

unhook

unhook(): void
Unhooks pointer listeners for drag panning.

Returns void