Class MapBrowserEvent

Classdesc

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

Param: type

Event type.

Param: map

Map.

Param: browserEvent

Browser event.

Param: opt_dragging

Is the map currently being dragged?

Param: opt_frameState

Frame state.

Hierarchy

Constructors

constructor

Properties

coordinate dragging frameState map originalEvent pixel target type

Methods

preventDefault stopPropagation

Constructors

constructor

  • new MapBrowserEvent(type, map, browserEvent, opt_dragging?, opt_frameState?): MapBrowserEvent

  • Parameters

    • type: string

      Event type.

    • map: Map

      Map.

    • browserEvent: Event

      Browser event.

    • Optional opt_dragging: boolean

      Is the map currently being dragged?

    • Optional opt_frameState: FrameState

      Frame state.

    Returns MapBrowserEvent

    Classdesc

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

Properties

coordinate

coordinate: Coordinate

The coordinate of the original browser event.

Api

stable

dragging

dragging: boolean

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

Api

stable

frameState

frameState: FrameState

The frame state at the time of the event.

Api

map

map: Map

The map where the event occurred.

Api

stable

originalEvent

originalEvent: Event

The original browser event.

Constant

Api

stable

pixel

pixel: Pixel

The pixel of the original browser event.

Api

stable

target

target: Object

The event target.

Api

stable

type

type: string

The event type.

Api

stable

Methods

preventDefault

  • preventDefault(): void

  • Stop event propagation.

    Returns void

    Function

    Api

    stable

stopPropagation

  • stopPropagation(): void

  • Stop event propagation.

    Returns void

    Function

    Api

    stable

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc