Class: MousePosition

ol/control/MousePosition~MousePosition


import MousePosition from 'ol/control/MousePosition';

A control to show the 2D coordinates of the mouse cursor. By default, these are in the view projection, but can be in any supported projection. By default the control is shown in the top right corner of the map, but this can be changed by using the css selector .ol-mouse-position.

On touch devices, which usually do not have a mouse cursor, the coordinates of the currently touched position are shown.

new MousePosition(opt_options)

control/MousePosition.js, line 59
Name Type Description
options

Mouse position options.

Name Type Description
className string (defaults to 'ol-mouse-position')

CSS class name.

coordinateFormat module:ol/coordinate~CoordinateFormat

Coordinate format.

projection module:ol/proj~ProjectionLike

Projection. Default is the view projection.

render function

Function called when the control should be re-rendered. This is called in a requestAnimationFrame callback.

target HTMLElement | string

Specify a target if you want the control to be rendered outside of the map's viewport.

undefinedHTML string (defaults to ' ')

Markup to show when coordinates are not available (e.g. when the pointer leaves the map viewport). By default, the last position will be replaced with ' ' ( ) when the pointer leaves the viewport. To retain the last rendered position, set this option to something falsey (like an empty string '').

Fires:

Extends

Observable Properties

Name Type Settable ol/Object.ObjectEvent type Description
coordinateFormat module:ol/coordinate~CoordinateFormat | undefined yes change:coordinateformat

The format to render the current position in.

projection module:ol/proj/Projection~Projection | undefined yes change:projection

The projection to report mouse position in.

Methods

changed() inherited

Observable.js, line 36

Increases the revision counter and dispatches a 'change' event.

dispatchEvent(event){boolean|undefined} inherited

events/Target.js, line 96

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name Type Description
event Object | module:ol/events/Event~BaseEvent | string

Event object.

Returns:
false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited

Object.js, line 119

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

getCoordinateFormat(){module:ol/coordinate~CoordinateFormat|undefined}

control/MousePosition.js, line 128

Return the coordinate format type used to render the current position or undefined.

Returns:
The format to render the current position in.

getKeys(){Array.<string>} inherited

Object.js, line 132

Get a list of object property names.

Returns:
List of property names.

getMap(){module:ol/PluggableMap~PluggableMap} inherited

control/Control.js, line 106

Get the map associated with this control.

Returns:
Map.

getProjection(){module:ol/proj/Projection~Projection|undefined}

control/MousePosition.js, line 141

Return the projection that is used to report the mouse position.

Returns:
The projection to report mouse position in.

getProperties(){Object.<string, *>} inherited

Object.js, line 141

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 47

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 60

Listen for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 82

Listen once for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

render(mapEvent) inherited

control/Control.js, line 144

Update the projection. Rendering of the coordinates is done in handleMouseMove and handleMouseUp.

Name Type Description
mapEvent module:ol/MapEvent~MapEvent

Map event.

set(key, value, opt_silent) inherited

Object.js, line 164

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

silent boolean

Update without triggering an event.

setCoordinateFormat(format)

control/MousePosition.js, line 190

Set the coordinate format type used to render the current position.

Name Type Description
format module:ol/coordinate~CoordinateFormat

The format to render the current position in.

setMap(map) inherited

control/Control.js, line 117

Remove the control from its current map and attach it to the new map. Subclasses may set up event handlers to get notified about changes to the map here.

Name Type Description
map module:ol/PluggableMap~PluggableMap

Map.

setProjection(projection)

control/MousePosition.js, line 201

Set the projection that is used to report the mouse position.

Name Type Description
projection module:ol/proj~ProjectionLike

The projection to report mouse position in.

setProperties(values, opt_silent) inherited

Object.js, line 183

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name Type Description
values Object.<string, *>

Values.

silent boolean

Update without triggering an event.

setTarget(target) inherited

control/Control.js, line 157

This function is used to set a target element for the control. It has no effect if it is called after the control has been added to the map (i.e. after setMap is called on the control). If no target is set in the options passed to the control constructor and if setTarget is not called then the control is added to the map's overlay container.

Name Type Description
target HTMLElement | string

Target.

un(type, listener) inherited

Observable.js, line 101

Unlisten for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

unset(key, opt_silent) inherited

Object.js, line 195

Unsets a property.

Name Type Description
key string

Key name.

silent boolean

Unset without triggering an event.