forked from openlayers/openlayers
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introducing ol.overlay.Overlay and an overlayContainer
ol.overlay.Overlay can be used to bind DOM elements to a coordinate on the map. It has positioning options to support e.g. popups or image markers that have an anchor at the bottom and an unknown size. The overlayContainer stops propagation on mousedown and touchstart events, so clicks and gestures on overlays don't trigger any MapBrowserEvent. To make this work reliably, we now only fire dblclick in mapbrowserevent.js when there was a previous mousedown or touchstart. The default container for controls is now the overlayContainer.
- Loading branch information
Showing
9 changed files
with
225 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,185 @@ | ||
| goog.provide('ol.overlay.Overlay'); | ||
| goog.provide('ol.overlay.OverlayOptions'); | ||
| goog.provide('ol.overlay.OverlayPositioning'); | ||
|
|
||
| goog.require('goog.events'); | ||
| goog.require('goog.style'); | ||
| goog.require('ol.Map'); | ||
| goog.require('ol.MapProperty'); | ||
|
|
||
|
|
||
| /** | ||
| * @typedef {{coordinate: (ol.Coordinate|undefined), | ||
| * element: (Element|undefined), | ||
| * map: (ol.Map|undefined), | ||
| * positioning: (Array.<string>|undefined)}} | ||
| */ | ||
| ol.overlay.OverlayOptions; | ||
|
|
||
|
|
||
|
|
||
| /** | ||
| * @constructor | ||
| * @param {ol.overlay.OverlayOptions} overlayOptions Overlay options. | ||
| */ | ||
| ol.overlay.Overlay = function(overlayOptions) { | ||
|
|
||
| /** | ||
| * @type {ol.Coordinate} | ||
| * @private | ||
| */ | ||
| this.coordinate_ = null; | ||
|
|
||
| /** | ||
| * @type {Element} | ||
| * @private | ||
| */ | ||
| this.element_ = null; | ||
|
|
||
| /** | ||
| * @private | ||
| * @type {ol.Map} | ||
| */ | ||
| this.map_ = null; | ||
|
|
||
| /** | ||
| * @type {Array.<string>} | ||
| * @private | ||
| */ | ||
| this.positioning_ = [ | ||
| ol.overlay.OverlayPositioning.LEFT, | ||
| ol.overlay.OverlayPositioning.BOTTOM | ||
| ]; | ||
|
|
||
| /** | ||
| * @private | ||
| * @type {Array.<number>} | ||
| */ | ||
| this.mapListenerKeys_ = []; | ||
|
|
||
| if (goog.isDef(overlayOptions.coordinate)) { | ||
| this.setCoordinate(overlayOptions.coordinate); | ||
| } | ||
| if (goog.isDef(overlayOptions.element)) { | ||
| this.setElement(overlayOptions.element); | ||
| } | ||
| if (goog.isDef(overlayOptions.map)) { | ||
| this.setMap(overlayOptions.map); | ||
| } | ||
| if (goog.isDef(overlayOptions.positioning)) { | ||
| this.setPositioning(overlayOptions.positioning); | ||
| } | ||
| }; | ||
|
|
||
|
|
||
| /** | ||
| * @param {ol.Coordinate} coordinate Coordinate for the overlay's position on | ||
| * the map. | ||
| */ | ||
| ol.overlay.Overlay.prototype.setCoordinate = function(coordinate) { | ||
| this.coordinate_ = coordinate; | ||
| this.updatePixelPosition_(); | ||
| }; | ||
|
|
||
|
|
||
| /** | ||
| * @param {Element} element The DOM element for the overlay. | ||
| */ | ||
| ol.overlay.Overlay.prototype.setElement = function(element) { | ||
| if (this.element_) { | ||
| goog.dom.removeNode(this.element_); | ||
| } | ||
| this.element_ = element; | ||
| if (this.map_) { | ||
| goog.dom.append(/** @type {!Node} */ (this.map_.getOverlayContainer()), | ||
| this.element_); | ||
| } | ||
| this.updatePixelPosition_(); | ||
| }; | ||
|
|
||
|
|
||
| /** | ||
| * @return {Element} The DOM element for the overlay. | ||
| */ | ||
| ol.overlay.Overlay.prototype.getElement = function() { | ||
| return this.element_; | ||
| }; | ||
|
|
||
|
|
||
| /** | ||
| * @param {ol.Map} map Map. | ||
| */ | ||
| ol.overlay.Overlay.prototype.setMap = function(map) { | ||
| this.map_ = map; | ||
| goog.array.forEach(this.mapListenerKeys_, goog.events.unlistenByKey); | ||
| if (this.element_) { | ||
| this.setElement(this.element_); | ||
| } | ||
| this.mapListenerKeys_ = map ? [ | ||
| goog.events.listen( | ||
| map, ol.Object.getChangedEventType(ol.MapProperty.CENTER), | ||
| this.updatePixelPosition_, false, this), | ||
| goog.events.listen( | ||
| map, ol.Object.getChangedEventType(ol.MapProperty.RESOLUTION), | ||
| this.updatePixelPosition_, false, this), | ||
| goog.events.listen( | ||
| map, ol.Object.getChangedEventType(ol.MapProperty.ROTATION), | ||
| this.updatePixelPosition_, false, this), | ||
| goog.events.listen( | ||
| map, ol.Object.getChangedEventType(ol.MapProperty.SIZE), | ||
| this.updatePixelPosition_, false, this) | ||
| ] : []; | ||
| this.updatePixelPosition_(); | ||
| }; | ||
|
|
||
|
|
||
| /** | ||
| * @return {ol.Map} Map. | ||
| */ | ||
| ol.overlay.Overlay.prototype.getMap = function() { | ||
| return this.map_; | ||
| }; | ||
|
|
||
|
|
||
| /** | ||
| * Set the CSS properties to use for x- and y-positioning of the element. If | ||
| * not set, the default is {@code ['left', 'bottom']}. | ||
| * @param {Array.<string>} positioning The positioning. | ||
| */ | ||
| ol.overlay.Overlay.prototype.setPositioning = function(positioning) { | ||
| this.positioning_ = positioning; | ||
| this.updatePixelPosition_(); | ||
| }; | ||
|
|
||
|
|
||
| /** | ||
| * @private | ||
| */ | ||
| ol.overlay.Overlay.prototype.updatePixelPosition_ = function() { | ||
| if (!goog.isNull(this.map_) && !goog.isNull(this.coordinate_) && | ||
| !goog.isNull(this.element_)) { | ||
| var pixel = this.map_.getPixelFromCoordinate(this.coordinate_); | ||
| var mapSize = this.map_.get(ol.MapProperty.SIZE); | ||
| var x = Math.round(pixel.x); | ||
| if (this.positioning_[0] === ol.overlay.OverlayPositioning.RIGHT) { | ||
| x = mapSize.width - x; | ||
| } | ||
| var y = Math.round(pixel.y); | ||
| if (this.positioning_[1] === ol.overlay.OverlayPositioning.BOTTOM) { | ||
| y = mapSize.height - y; | ||
| } | ||
| goog.style.setStyle(this.element_, this.positioning_[0], x + 'px'); | ||
| goog.style.setStyle(this.element_, this.positioning_[1], y + 'px'); | ||
| } | ||
| }; | ||
|
|
||
|
|
||
| /** | ||
| * @enum {string} | ||
| */ | ||
| ol.overlay.OverlayPositioning = { | ||
| LEFT: 'left', | ||
| RIGHT: 'right', | ||
| TOP: 'top', | ||
| BOTTOM: 'bottom' | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters