Skip to content

MapWheelEvent

Defined in: ui/events.ts:641

MapWheelEvent is the event type for the wheel map event.

Extends

Accessors

defaultPrevented

Get Signature

get defaultPrevented(): boolean

Defined in: ui/events.ts:669

true if preventDefault has been called.

Returns

boolean

Constructors

Constructor

new MapWheelEvent(type: string, map: MapLibreMap, originalEvent: WheelEvent): MapWheelEvent

Defined in: ui/events.ts:676

Parameters

Parameter Type
type string
map MapLibreMap
originalEvent WheelEvent

Returns

MapWheelEvent

Overrides

Event.constructor

Methods

preventDefault()

preventDefault(): void

Defined in: ui/events.ts:662

Prevents subsequent default processing of the event by the map.

Calling this method will prevent the behavior of ScrollZoomHandler.

Returns

void

Properties

originalEvent

originalEvent: WheelEvent

Defined in: ui/events.ts:655

The DOM event which caused the map event.


target

target: MapLibreMap

Defined in: ui/events.ts:650

The Map object that fired the event.


type

type: "wheel"

Defined in: ui/events.ts:645

The event type.

Overrides

Event.type