OpenLayers v4.0.1 API - Class: MousePosition

# Class: MousePosition

This documentation is for OpenLayers v4.0.1. The latest is v.

## 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`.

#### new ol.control.MousePosition(opt_options)

src/ol/control/mouseposition.js, line 26

  Name | Type | Description
  --- | --- | ---

  `options`

  Mouse position options.

  Name | Type | Description
  --- | --- | ---
  `className` | string | undefined | CSS class name. Default is `ol-mouse-position`.
  `coordinateFormat` | ol.CoordinateFormatType | undefined | Coordinate format.
  `projection` | ol.ProjectionLike | Projection.
  `render` | function | undefined | Function called when the control should be re-rendered. This is called in a requestAnimationFrame callback.
  `target` | Element | undefined | Target.
  `undefinedHTML` | string | undefined | Markup for undefined coordinates. Default is `` (empty string).

  ##### Fires:

  - `change` (ol.events.Event) - Generic change event. Triggered when the revision counter is increased.
  - `change:coordinateFormat` (ol.Object.Event)
  - `change:projection` (ol.Object.Event)
  - `propertychange` (ol.Object.Event) - Triggered when a property is changed.

### Extends

- ol.control.Control

### Observable Properties

Name | Type | Settable | ol.Object.Event type | Description
--- | --- | --- | --- | ---
`coordinateFormat` | ol.CoordinateFormatType | undefined | yes | `change:coordinateformat` | The format to render the current position in.
`projection` | ol.proj.Projection | undefined | yes | `change:projection` | The projection to report mouse position in.

### Methods

#### ol.control.MousePosition.render(mapEvent)

src/ol/control/mouseposition.js, line 93

  Update the mouseposition element.

  ##### This:

  - {ol.control.MousePosition}

  Name | Type | Description
  --- | --- | ---
  `mapEvent` | ol.MapEvent | Map event.

#### changed() inherited

src/ol/observable.js, line 58

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

#### dispatchEvent(event) inherited

src/ol/observable.js, line 75

  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 | ol.events.Event | string | Event object.

#### get(key){*} inherited

src/ol/object.js, line 101

  Gets a value.

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

  ##### Returns:

  Value.

#### getCoordinateFormat(){ol.CoordinateFormatType|undefined}

src/ol/control/mouseposition.js, line 123

  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

src/ol/object.js, line 115

  Get a list of object property names.

  ##### Returns:

  List of property names.

#### getMap(){ol.Map} inherited

src/ol/control/control.js, line 94

  Get the map associated with this control.

  ##### Returns:

  Map.

#### getProjection(){ol.proj.Projection|undefined}

src/ol/control/mouseposition.js, line 136

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

  ##### Returns:

  The projection to report mouse position in.

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

src/ol/object.js, line 125

  Get an object of all property names and values.

  ##### Returns:

  Object.

#### getRevision(){number} inherited

src/ol/observable.js, line 84

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

  ##### Returns:

  Revision.

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

src/ol/observable.js, line 99

  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.
  `this` | Object | The object to use as `this` in `listener`.

  ##### 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, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 124

  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.
  `this` | Object | The object to use as `this` in `listener`.

  ##### 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, opt_silent) inherited

src/ol/object.js, line 150

  Sets a value.

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

#### setCoordinateFormat(format)

src/ol/control/mouseposition.js, line 188

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

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

#### setMap(map) inherited

src/ol/control/control.js, line 107

  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` | ol.Map | Map.

#### setProjection(projection)

src/ol/control/mouseposition.js, line 200

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

  Name | Type | Description
  --- | --- | ---
  `projection` | ol.proj.Projection | The projection to report mouse position in.

#### setProperties(values, opt_silent) inherited

src/ol/object.js, line 170

  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

src/ol/control/control.js, line 138

  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` | Element | string | Target.

#### un(type, listener, opt_this) inherited

src/ol/observable.js, line 147

  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.
  `this` | Object | The object which was used as `this` by the `listener`.

#### unset(key, opt_silent) inherited

src/ol/object.js, line 184

  Unsets a property.

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