Class DragPanHandler

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

Methods

disable enable isActive isEnabled

Methods

disable

  • disable(): void

  • Disables the "drag to pan" interaction.

    Returns void

    Example

    map.dragPan.disable();

enable

  • enable(options?): void

  • Enables the "drag to pan" interaction.

    Parameters

    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.

Settings

Member Visibility

Theme

On This Page

disableenableisActiveisEnabled