Class MapBrowserEvent<EVENT>

Classdesc

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

Type Parameters

  • EVENT extends UIEvent

Hierarchy (view full)

Constructors

constructor

Properties

activePointers coordinate_ defaultPrevented dragging frameState map originalEvent pixel_ propagationStopped target type

Accessors

coordinate pixel

Methods

preventDefault stopPropagation

Constructors

constructor

  • new MapBrowserEvent<EVENT>(type, map, originalEvent, dragging?, frameState?, activePointers?): MapBrowserEvent<EVENT>

  • Type Parameters

    • EVENT extends UIEvent<EVENT>

    Parameters

    • type: string

      Event type.

    • map: external.ol.Map

      Map.

    • originalEvent: EVENT

      Original event.

    • Optional dragging: boolean

      Is the map currently being dragged?

    • Optional frameState: FrameState

      Frame state.

    • Optional activePointers: PointerEvent[]

      Active pointers.

    Returns MapBrowserEvent<EVENT>

Properties

activePointers

activePointers: undefined | PointerEvent[]

coordinate_

coordinate_: null | Coordinate

The coordinate in the user projection corresponding to the original browser event.

defaultPrevented

defaultPrevented: boolean

dragging

dragging: boolean

Indicates if the map is currently being dragged. Only set for POINTERDRAG and POINTERMOVE events. Default is false.

Api

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

originalEvent

originalEvent: EVENT

The original browser event.

Const

Api

pixel_

pixel_: null | Pixel

The map pixel relative to the viewport corresponding to the original browser event.

propagationStopped

propagationStopped: boolean

target

target: any

The event target.

Api

type

type: string

The event type.

Api

Accessors

coordinate

  • get coordinate(): Coordinate

  • The coordinate corresponding to the original browser event. This will be in the user projection if one is set. Otherwise it will be in the view projection.

    Returns Coordinate

    Api

  • set coordinate(arg): void

  • Parameters

    • arg: Coordinate

    Returns void

pixel

  • get pixel(): Pixel

  • The map pixel relative to the viewport corresponding to the original event.

    Returns Pixel

    Api

  • set pixel(arg): void

  • Parameters

    • arg: Pixel

    Returns void

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

constructoractivePointerscoordinate_defaultPreventeddraggingframeStatemaporiginalEventpixel_propagationStoppedtargettypecoordinatepixelpreventDefaultstopPropagation