@react-gis/openlayerscontrol

mouse-position-control

Functions

MousePositionControl()

function MousePositionControl(props: MousePositionControlProps): null;

Defined in: packages/openlayers/src/control/mouse-position-control.tsx:11

Parameters

ParameterType
propsMousePositionControlProps

Returns

null

Interfaces

MousePositionControlProps

Defined in: packages/openlayers/src/control/mouse-position-control.tsx:9

Extends

Properties

PropertyTypeDescriptionInherited from
className?stringCSS class name.ControlOptions.className
coordinateFormat?CoordinateFormatCoordinate format.ControlOptions.coordinateFormat
element?HTMLElementThe element is the control's container element. This only needs to be specified if you're developing a custom control.ControlOptions.element
placeholder?stringMarkup 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.ControlOptions.placeholder
projection?ProjectionLikeProjection. Default is the view projection.ControlOptions.projection
render?(arg0: MapEvent) => void & (arg0: MapEvent) => voidFunction called when the control should be re-rendered. This is called in a requestAnimationFrame callback.FullScreenControlProps.render
target?string | HTMLElementSpecify a target if you want the control to be rendered outside of the map's viewport.ControlOptions.target
wrapX?booleanWrap the world horizontally on the projection's antimeridian, if it is a global projection.ControlOptions.wrapX