Class MapEvent

Classdesc

Events emitted as map events are instances of this type. See module:ol/Map~Map for which events trigger a map event.

Hierarchy (view full)

Constructors

constructor

Properties

defaultPrevented frameState map propagationStopped target type

Methods

preventDefault stopPropagation

Constructors

constructor

  • new MapEvent(type, map, frameState?): MapEvent

  • Parameters

    • type: string

      Event type.

    • map: external.ol.Map

      Map.

    • Optional frameState: null | FrameState

      Frame state.

    Returns MapEvent

Properties

defaultPrevented

defaultPrevented: boolean

frameState

frameState: null | FrameState

The frame state at the time of the event.

Api

map

map: external.ol.Map

The map where the event occurred.

Api

propagationStopped

propagationStopped: boolean

target

target: any

The event target.

Api

type

type: string

The event type.

Api

Methods

preventDefault

  • preventDefault(): void

  • Prevent default. This means that no emulated click, singleclick or doubleclick events will be fired.

    Returns void

    Api

stopPropagation

  • stopPropagation(): void

  • Stop event propagation.

    Returns void

    Api

Settings

Member Visibility

On This Page

constructordefaultPreventedframeStatemappropagationStoppedtargettypepreventDefaultstopPropagation