On this page

Class MapWheelEvent

MapWheelEvent is the event type for the wheel map event.

Hierarchy (View Summary)

Event
- MapWheelEvent
  - MapWheelEvent

Index

Constructors

Properties

originalEvent target type

Accessors

defaultPrevented

Methods

Constructors

constructor

new MapWheelEvent(
    type: string,
    map: MapLibreMap,
    originalEvent: WheelEvent,
): MapWheelEvent
Parameters
- type: string
- map: MapLibreMap
- originalEvent: WheelEvent
Returns MapWheelEvent
Overrides Event.constructor

Properties

originalEvent

originalEvent: WheelEvent

The DOM event which caused the map event.

target

target: MapLibreMap

The Map object that fired the event.

type

type: "wheel"

The event type.

Accessors

defaultPrevented

get defaultPrevented(): boolean
true if preventDefault has been called.

Returns boolean

Methods

preventDefault

preventDefault(): void
Prevents subsequent default processing of the event by the map.

Calling this method will prevent the behavior of ScrollZoomHandler.

Returns void

Was this helpful?