Move MousePositionOptions to ol/control/MousePosition
This commit is contained in:
@@ -21,6 +21,23 @@ const PROJECTION = 'projection';
|
||||
const COORDINATE_FORMAT = 'coordinateFormat';
|
||||
|
||||
|
||||
/**
|
||||
* @typedef {Object} Options
|
||||
* @property {string|undefined} className CSS class name. Default is
|
||||
* `'ol-mouse-position'`.
|
||||
* @property {module:ol/coordinate~CoordinateFormat|undefined} coordinateFormat
|
||||
* Coordinate format.
|
||||
* @property {ol.ProjectionLike} projection Projection.
|
||||
* @property {function(ol.MapEvent)|undefined} render Function called when the
|
||||
* control should be re-rendered. This is called in a `requestAnimationFrame`
|
||||
* callback.
|
||||
* @property {Element|string|undefined} target Specify a target if you want the
|
||||
* control to be rendered outside of the map's viewport.
|
||||
* @property {string|undefined} undefinedHTML Markup for undefined coordinates.
|
||||
* Default is `''` (empty string).
|
||||
*/
|
||||
|
||||
|
||||
/**
|
||||
* @classdesc
|
||||
* A control to show the 2D coordinates of the mouse cursor. By default, these
|
||||
@@ -30,7 +47,7 @@ const COORDINATE_FORMAT = 'coordinateFormat';
|
||||
*
|
||||
* @constructor
|
||||
* @extends {ol.control.Control}
|
||||
* @param {olx.control.MousePositionOptions=} opt_options Mouse position
|
||||
* @param {module:ol/control/MousePosition~Options=} opt_options Mouse position
|
||||
* options.
|
||||
* @api
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user