Class: MousePosition

Extends

• ol.control.Control

Observable Properties

Name	Type	Settable	ol.ObjectEvent 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

bindTo(key, target, opt_targetKey){ol.ObjectAccessor} inherited experimental

src/ol/object.js, line 301

The bindTo method allows you to set up a two-way binding between a source and target object. The method returns an object with a transform method that you can use to provide from and to functions to 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;
    }
  );

Name	Type	Description
key	string	Key name.
target	ol.Object	Target.
targetKey	string	Target key.

dispatchChangeEvent() inherited experimental

src/ol/observable.js, line 42

Dispatches a change event.

Fires:

• change experimental

get(key){*} inherited experimental

src/ol/object.js, line 358

Gets a value.

Name	Type	Description
key	string	Key name.

Returns:

Value.

getCoordinateFormat(){ol.CoordinateFormatType|undefined}

src/ol/control/mousepositioncontrol.js, line 135

Returns:

The format to render the current position in.

getKeys(){Array.<string>} inherited experimental

src/ol/object.js, line 386

Get a list of object property names.

Returns:

List of property names.

getMap(){ol.Map} inherited

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

Get the map associated with this control.

Returns:

Map.

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

src/ol/control/mousepositioncontrol.js, line 151

Returns:

The projection to report mouse position in.

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

src/ol/object.js, line 418

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited experimental

src/ol/observable.js, line 52

Returns:

Revision.

on(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 65

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.

once(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 78

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.

set(key, value) inherited experimental

src/ol/object.js, line 448

Sets a value.

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

setCoordinateFormat(format)

src/ol/control/mousepositioncontrol.js, line 208

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

setMap(map){undefined}

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

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.

Returns:

Undefined.

setProjection(projection)

src/ol/control/mousepositioncontrol.js, line 223

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

setProperties(values) inherited experimental

src/ol/object.js, line 477

Sets a collection of key-value pairs.

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

un(type, listener, opt_this) inherited

src/ol/observable.js, line 91

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.

unbind(key) inherited experimental

src/ol/object.js, line 491

Removes a binding. Unbinding will set the unbound property to the current value. The object will not be notified, as the value has not changed.

Name	Type	Description
key	string	Key name.

unbindAll() inherited experimental

src/ol/object.js, line 515

Removes all bindings.

unByKey(key) inherited

src/ol/observable.js, line 101

Removes an event listener using the key returned by on() or once().

Name	Type	Description
key	goog.events.Key	Key.