@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
| Parameter | Type |
|---|---|
props | MousePositionControlProps |
Returns
null
Interfaces
MousePositionControlProps
Defined in: packages/openlayers/src/control/mouse-position-control.tsx:9
Extends
ControlOptions<OlMousePositionOptions>
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
className? | string | CSS class name. | ControlOptions.className |
coordinateFormat? | CoordinateFormat | Coordinate format. | ControlOptions.coordinateFormat |
element? | HTMLElement | The element is the control's container element. This only needs to be specified if you're developing a custom control. | ControlOptions.element |
placeholder? | string | 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. | ControlOptions.placeholder |
projection? | ProjectionLike | Projection. Default is the view projection. | ControlOptions.projection |
render? | (arg0: MapEvent) => void & (arg0: MapEvent) => void | Function called when the control should be re-rendered. This is called in a requestAnimationFrame callback. | FullScreenControlProps.render |
target? | string | HTMLElement | Specify a target if you want the control to be rendered outside of the map's viewport. | ControlOptions.target |
wrapX? | boolean | Wrap the world horizontally on the projection's antimeridian, if it is a global projection. | ControlOptions.wrapX |