Module: ol/control/MousePosition

ol/control/MousePosition


Classes

MousePosition

Type Definitions

Options{Object}

Properties:
Name Type Description
className string
(defaults to 'ol-mouse-position')

CSS class name.

coordinateFormat CoordinateFormat | undefined

Coordinate format.

projection ProjectionLike | undefined

Projection. Default is the view projection.

render function | undefined

Function called when the control should be re-rendered. This is called in a requestAnimationFrame callback.

target HTMLElement | string | undefined

Specify a target if you want the control to be rendered outside of the map's viewport.

placeholder string | undefined

Markup to show when the mouse position is not available (e.g. when the pointer leaves the map viewport). By default, a non-breaking space is rendered initially and the last position is retained when the mouse leaves the viewport. When a string is provided (e.g. 'no position' or '' for an empty string) it is used as a placeholder.

wrapX boolean
(defaults to true)

Wrap the world horizontally on the projection's antimeridian, if it is a global projection.