new ol.control.MousePosition(opt_options)
Name | Type | Description | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Mouse position options.
|
Fires:
-
change
(ol.events.Event) experimental - Generic change event. Triggered when the revision counter is increased. -
change:coordinateFormat
(ol.ObjectEvent) -
change:projection
(ol.ObjectEvent) -
propertychange
(ol.ObjectEvent) - Triggered when a property is changed.
Extends
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
-
ol.control.MousePosition.render(mapEvent) experimental
src/ol/control/mouseposition.js, line 93 -
Update the mouseposition element.
This:
Name Type Description mapEvent
ol.MapEvent Map event.
-
changed() inherited experimental
src/ol/observable.js, line 58 -
Increases the revision counter and dispatches a 'change' event.
-
dispatchEvent(event) inherited experimental
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 148 -
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 162 -
Get a list of object property names.
Returns:
List of property names.
-
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 172 -
Get an object of all property names and values.
Returns:
Object.
-
getRevision(){number} inherited experimental
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
inlistener
.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
inlistener
.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 197 -
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 106 -
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 217 -
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 experimental
src/ol/control/control.js, line 137 -
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 notarget
is set in the options passed to the control constructor and ifsetTarget
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 thelistener
. -
unByKey(key) inherited
src/ol/observable.js, line 168 -
Removes an event listener using the key returned by
on()
oronce()
. Note that using theol.Observable.unByKey
static function is to be preferred.Name Type Description key
ol.EventsKey | Array.<ol.EventsKey> The key returned by
on()
oronce()
(or an array of keys). -
unset(key, opt_silent) inherited
src/ol/object.js, line 231 -
Unsets a property.
Name Type Description key
string Key name.
silent
boolean Unset without triggering an event.