# Class: MousePosition

This documentation is for OpenLayers v10.9.0. The latest is v.

## ol/control/MousePosition~MousePosition

    import MousePosition from 'ol/control/MousePosition.js';

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(options)

control/MousePosition.js, line 66

  Name | Type | Description
  --- | --- | ---
  `className` | string (defaults to 'ol-mouse-position') | CSS class name.
  `coordinateFormat` | CoordinateFormat | undefined | Coordinate format.
  `projection` | ProjectionLike | undefined | Projection. Default is the view projection.
  `render` | function | undefined | Function called when the control should be re-rendered. This is called in a `requestAnimationFrame` callback.
  `target` | HTMLElement | string | undefined | Specify a target if you want the control to be rendered outside of the map's viewport.
  `placeholder` | string | undefined | Markup to show when the mouse position is not available (e.g. when the pointer leaves the map viewport). By default, a non-breaking space is rendered initially and the last position is retained when the mouse leaves the viewport. When a string is provided (e.g. `'no position'` or `''` for an empty string) it is used as a placeholder.
  `wrapX` | boolean (defaults to true) | Wrap the world horizontally on the projection's antimeridian, if it is a global projection.

  ##### Fires:

  - `change` (BaseEvent) - Generic change event. Triggered when the revision counter is increased.
  - `change:coordinateFormat` (ObjectEvent)
  - `change:projection` (ObjectEvent)
  - `error` (BaseEvent) - Generic error event. Triggered when an error occurs.
  - `propertychange` (ObjectEvent) - Triggered when a property is changed.

### Extends

- Control

### Observable Properties

Name | Type | Settable | ObjectEvent type | Description
--- | --- | --- | --- | ---
`coordinateFormat` | CoordinateFormat | undefined | yes | `change:coordinateformat` | The format to render the current position in.
`projection` | Projection | undefined | yes | `change:projection` | The projection to report mouse position in.

### Methods

#### changed() inherited

Observable.js, line 68

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

#### dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

  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` | 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 136

  Gets a value.

  Name | Type | Description
  --- | --- | ---
  `key` | string | Key name.

  ##### Returns:

  Value.

#### getCoordinateFormat(){CoordinateFormat | undefined}

control/MousePosition.js, line 159

  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 149

  Get a list of object property names.

  ##### Returns:

  List of property names.

#### getMap(){Map | null} inherited

control/Control.js, line 104

  Get the map associated with this control.

  ##### Returns:

  Map.

#### getProjection(){Projection | undefined}

control/MousePosition.js, line 172

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

  ##### Returns:

  The projection to report mouse position in.

#### getProperties(){NoInfer.<Properties>} inherited

Object.js, line 158

  Get an object of all property names and values.

  ##### Returns:

  Object.

#### getRevision(){number} inherited

Observable.js, line 79

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

  ##### Returns:

  Revision.

#### on(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 152

  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){EventsKey | Array<EventsKey>} inherited

Observable.js, line 164

  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.

#### set(key, value, silent) inherited

Object.js, line 218

  Sets a value.

  Name | Type | Description
  --- | --- | ---
  `key` | string | Key name.
  `value` | * | Value.
  `silent` | boolean | undefined | Update without triggering an event.

#### setCoordinateFormat(format)

control/MousePosition.js, line 227

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

  Name | Type | Description
  --- | --- | ---
  `format` | CoordinateFormat | The format to render the current position in.

#### setMap(map)

control/MousePosition.js, line 204

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

  Name | Type | Description
  --- | --- | ---
  `map` | Map | null | Map.

#### setProjection(projection)

control/MousePosition.js, line 238

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

  Name | Type | Description
  --- | --- | ---
  `projection` | ProjectionLike | The projection to report mouse position in.

#### setProperties(values, silent) inherited

Object.js, line 238

  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` | Partial.<NoInfer.<Properties>> | Values.
  `silent` | boolean | undefined | Update without triggering an event.

#### setTarget(target) inherited

control/Control.js, line 155

  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 173

  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, silent) inherited

Object.js, line 262

  Unsets a property.

  Name | Type | Description
  --- | --- | ---
  `key` | string | Key name.
  `silent` | boolean | undefined | Unset without triggering an event.