OpenLayers 3 API Documentation - Class: ol.control.MousePosition

new MousePosition

Stability: experimental

Create a new control to show the position of the mouse in the map's projection (or any other supplied projection). By default the control is shown in the top right corner of the map but this can be changed by using a css selector .ol-mouse-position.

Parameters:

Name	Type	Argument	Description
`options`	olx.control.MousePositionOptions	<optional>	Mouse position options.

Source:

mousepositioncontrol.js, line 47

Extends

ol.control.Control

Observable Properties

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

Methods

bindTo Stability: experimental

The bindTo method allows you to set up a two-way binding between a source and target object. The method returns an ol.ObjectAccessor with a transform method that lets you transform values on the way from the source to the target and on the way back.

For example, if you had two map views (sourceView and targetView) and you wanted the target view to have double the resolution of the source view, you could transform the resolution on the way to and from the target with the following:

sourceView.bindTo('resolution', targetView)
  .transform(
    function(sourceResolution) {
      // from sourceView.resolution to targetView.resolution
      return 2 * sourceResolution;
    },
    function(targetResolution) {
      // from targetView.resolution to sourceView.resolution
      return targetResolution / 2;
    }
  );

Parameters:

Name	Type	Argument	Description
`key`	string		Key name.
`target`	ol.Object		Target.
`targetKey`	string	<optional>	Target key.

Inherited From:

ol.Object#bindTo

Source:

object.js, line 232

Returns:

Type: ol.ObjectAccessor

dispatchChangeEvent Stability: experimental

Inherited From:

ol.Observable#dispatchChangeEvent

Source:

observable.js, line 35

get Stability: experimental

Gets a value.

Parameters:

Name	Type	Description
`key`	string	Key name.

Inherited From:

ol.Object#get

Source:

object.js, line 289

Returns:

Value.

Type: *

getCoordinateFormat Stability: experimental

Source:

mousepositioncontrol.js, line 138

Returns:

projection.

Type: ol.CoordinateFormatType | undefined

getMap Stability: experimental

Get the map associated with this control.

Inherited From:

ol.control.Control#getMap

Source:

control.js, line 68

Returns:

Map.

Type: ol.Map

getProjection Stability: experimental

Source:

mousepositioncontrol.js, line 152

Returns:

projection.

Type: ol.proj.Projection | undefined

getProperties Stability: experimental

Get an object of all property names and values.

Inherited From:

ol.Object#getProperties

Source:

object.js, line 348

Returns:

Object.

Type: Object.<string, *>

notify Stability: experimental

Notify all observers of a change on this property. This notifies both objects that are bound to the object's property as well as the object that it is bound to.

Parameters:

Name	Type	Description
`key`	string	Key name.

Inherited From:

ol.Object#notify

Source:

object.js, line 368

on Stability: experimental

Listen for a certain type of event.

Parameters:

Name	Type	Argument	Description
`type`	string \| Array.<string>		The event type or array of event types.
`listener`	function		The listener function.
`this`	Object	<optional>	The object to use as `this` in `listener`.

Inherited From:

ol.Observable#on

Source:

observable.js, line 58

Returns:

Unique key for the listener.

Type: goog.events.Key

once Stability: experimental

Listen once for a certain type of event.

Parameters:

Name	Type	Argument	Description
`type`	string \| Array.<string>		The event type or array of event types.
`listener`	function		The listener function.
`this`	Object	<optional>	The object to use as `this` in `listener`.

Inherited From:

ol.Observable#once

Source:

observable.js, line 71

Returns:

Unique key for the listener.

Type: goog.events.Key

set Stability: experimental

Sets a value.

Parameters:

Name	Type	Description
`key`	string	Key name.
`value`	*	Value.

Inherited From:

ol.Object#set

Source:

object.js, line 399

setCoordinateFormat Stability: experimental

Parameters:

Name	Type	Description
`format`	ol.CoordinateFormatType	Coordinate format.

Source:

mousepositioncontrol.js, line 206

setMap Stability: experimental

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.

Parameters:

Name	Type	Description
`map`	ol.Map	Map.

Inherited From:

ol.control.Control#setMap

Source:

control.js, line 89

setProjection Stability: experimental

Parameters:

Name	Type	Description
`projection`	ol.proj.Projection	Projection.

Source:

mousepositioncontrol.js, line 219

setValues Stability: experimental

Sets a collection of key-value pairs.

Parameters:

Name	Type	Description
`values`	Object.<string, *>	Values.

Inherited From:

ol.Object#setValues

Source:

object.js, line 428

un Stability: experimental

Unlisten for a certain type of event.

Parameters:

Name	Type	Argument	Description
`type`	string \| Array.<string>		The event type or array of event types.
`listener`	function		The listener function.
`this`	Object	<optional>	The object to use as `this` in `listener`.