new ol.control.MousePosition(opt_options)
| Name | Type | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Mouse position options.
|
||||||||||||||||||||||
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
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:
Name Type Description mapEventol.MapEvent Map event.
-
Increases the revision counter and dispatches a 'change' event.
-
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
typeproperty.Name Type Description eventObject | ol.events.Event | string Event object.
-
Gets a value.
Name Type Description keystring Key name.
Returns:
Value.
-
Return the coordinate format type used to render the current position or undefined.
Returns:
The format to render the current position in.
-
Get a list of object property names.
Returns:
List of property names.
-
Get the map associated with this control.
Returns:
Map.
-
Return the projection that is used to report the mouse position.
Returns:
The projection to report mouse position in.
-
Get an object of all property names and values.
Returns:
Object.
-
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 typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object to use as
thisinlistener.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 typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object to use as
thisinlistener.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.
-
Sets a value.
Name Type Description keystring Key name.
value* Value.
silentboolean 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 formatol.CoordinateFormatType The format to render the current position in.
-
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 mapol.PluggableMap Map.
-
setProjection(projection)
src/ol/control/mouseposition.js, line 200 -
Set the projection that is used to report the mouse position.
Name Type Description projectionol.ProjectionLike The projection to report mouse position in.
-
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 valuesObject.<string, *> Values.
silentboolean Update without triggering an event.
-
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
setMapis called on the control). If notargetis set in the options passed to the control constructor and ifsetTargetis not called then the control is added to the map's overlay container.Name Type Description targetElement | string Target.
-
Unlisten for a certain type of event.
Name Type Description typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object which was used as
thisby thelistener. -
Unsets a property.
Name Type Description keystring Key name.
silentboolean Unset without triggering an event.
OpenLayers