On this page

Class DragPanHandler

The DragPanHandler allows the user to pan the map by clicking and dragging the cursor.

Index

Constructors

Methods

disable enable isActive isEnabled

Constructors

constructor

new DragPanHandler(
    el: HTMLElement,
    mousePan: MousePanHandler,
    touchPan: TouchPanHandler,
): DragPanHandler
Parameters
- el: HTMLElement
- mousePan: MousePanHandler
- touchPan: TouchPanHandler
Returns DragPanHandler
Internal

Methods

disable

disable(): void
Disables the "drag to pan" interaction.

Returns void
Example
```
map.dragPan.disable();
```

enable

enable(options?: boolean | DragPanOptions): void
Enables the "drag to pan" interaction.
Parameters
- Optionaloptions: boolean | DragPanOptions
  Options object
Returns void
Example
```
  map.dragPan.enable();
  map.dragPan.enable({
     linearity: 0.3,
     easing: bezier(0, 0, 0.3, 1),
     maxSpeed: 1400,
     deceleration: 2500,
  });
```

isActive

isActive(): boolean
Returns a Boolean indicating whether the "drag to pan" interaction is active, i.e. currently being used.

Returns boolean
true if the "drag to pan" interaction is active.

isEnabled

isEnabled(): boolean
Returns a Boolean indicating whether the "drag to pan" interaction is enabled.

Returns boolean
true if the "drag to pan" interaction is enabled.

Was this helpful?