Skip to content

MapWheelEvent

Defined in: ui/events.ts:756

MapWheelEvent is the event type for the wheel map event.

Extends

Accessors

defaultPrevented

Get Signature

get defaultPrevented(): boolean

Defined in: ui/events.ts:784

true if preventDefault has been called.

Returns

boolean

Constructors

Constructor

new MapWheelEvent(map: Map, originalEvent: WheelEvent): MapWheelEvent

Defined in: ui/events.ts:791

Parameters

Parameter Type
map Map
originalEvent WheelEvent

Returns

MapWheelEvent

Overrides

MapLibreEvent<WheelEvent>.constructor

Methods

preventDefault()

preventDefault(): void

Defined in: ui/events.ts:777

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:770

The DOM event which caused the map event.

Overrides

MapLibreEvent.originalEvent


target

target: Map

Defined in: ui/events.ts:765

The Map object that fired the event.

Overrides

MapLibreEvent.target


type

type: "wheel"

Defined in: ui/events.ts:760

The event type.

Overrides

MapLibreEvent.type