From 556e443705ba4cb8fda91cb3c00dca7d42c001a8 Mon Sep 17 00:00:00 2001 From: Frederic Junod Date: Mon, 29 Aug 2016 12:18:55 +0200 Subject: [PATCH] Rename ol.OverlayProperty to ol.Overlay.Property --- changelog/upgrade-notes.md | 1 + src/ol/overlay.js | 56 +++++++++++++++++++------------------- 2 files changed, 29 insertions(+), 28 deletions(-) diff --git a/changelog/upgrade-notes.md b/changelog/upgrade-notes.md index e96ad141de..d543af1dff 100644 --- a/changelog/upgrade-notes.md +++ b/changelog/upgrade-notes.md @@ -15,6 +15,7 @@ A number of internal types have been renamed. This will not affect those who us * rename `ol.CollectionProperty` to `ol.Collection.Property` * rename `ol.DeviceOrientationProperty` to `ol.DeviceOrientation.Property` * rename `ol.GeolocationProperty` to `ol.Geolocation.Property` + * rename `ol.OverlayProperty` to `ol.Overlay.Property` ### v3.18.0 diff --git a/src/ol/overlay.js b/src/ol/overlay.js index 3214338282..f6355e5a65 100644 --- a/src/ol/overlay.js +++ b/src/ol/overlay.js @@ -10,18 +10,6 @@ goog.require('ol.dom'); goog.require('ol.extent'); -/** - * @enum {string} - */ -ol.OverlayProperty = { - ELEMENT: 'element', - MAP: 'map', - OFFSET: 'offset', - POSITION: 'position', - POSITIONING: 'positioning' -}; - - /** * Overlay position: `'bottom-left'`, `'bottom-center'`, `'bottom-right'`, * `'center-left'`, `'center-center'`, `'center-right'`, `'top-left'`, @@ -136,23 +124,23 @@ ol.Overlay = function(options) { this.mapPostrenderListenerKey_ = null; ol.events.listen( - this, ol.Object.getChangeEventType(ol.OverlayProperty.ELEMENT), + this, ol.Object.getChangeEventType(ol.Overlay.Property.ELEMENT), this.handleElementChanged, this); ol.events.listen( - this, ol.Object.getChangeEventType(ol.OverlayProperty.MAP), + this, ol.Object.getChangeEventType(ol.Overlay.Property.MAP), this.handleMapChanged, this); ol.events.listen( - this, ol.Object.getChangeEventType(ol.OverlayProperty.OFFSET), + this, ol.Object.getChangeEventType(ol.Overlay.Property.OFFSET), this.handleOffsetChanged, this); ol.events.listen( - this, ol.Object.getChangeEventType(ol.OverlayProperty.POSITION), + this, ol.Object.getChangeEventType(ol.Overlay.Property.POSITION), this.handlePositionChanged, this); ol.events.listen( - this, ol.Object.getChangeEventType(ol.OverlayProperty.POSITIONING), + this, ol.Object.getChangeEventType(ol.Overlay.Property.POSITIONING), this.handlePositioningChanged, this); if (options.element !== undefined) { @@ -181,7 +169,7 @@ ol.inherits(ol.Overlay, ol.Object); */ ol.Overlay.prototype.getElement = function() { return /** @type {Element|undefined} */ ( - this.get(ol.OverlayProperty.ELEMENT)); + this.get(ol.Overlay.Property.ELEMENT)); }; @@ -203,7 +191,7 @@ ol.Overlay.prototype.getId = function() { */ ol.Overlay.prototype.getMap = function() { return /** @type {ol.Map|undefined} */ ( - this.get(ol.OverlayProperty.MAP)); + this.get(ol.Overlay.Property.MAP)); }; @@ -215,7 +203,7 @@ ol.Overlay.prototype.getMap = function() { */ ol.Overlay.prototype.getOffset = function() { return /** @type {Array.} */ ( - this.get(ol.OverlayProperty.OFFSET)); + this.get(ol.Overlay.Property.OFFSET)); }; @@ -228,7 +216,7 @@ ol.Overlay.prototype.getOffset = function() { */ ol.Overlay.prototype.getPosition = function() { return /** @type {ol.Coordinate|undefined} */ ( - this.get(ol.OverlayProperty.POSITION)); + this.get(ol.Overlay.Property.POSITION)); }; @@ -241,7 +229,7 @@ ol.Overlay.prototype.getPosition = function() { */ ol.Overlay.prototype.getPositioning = function() { return /** @type {ol.OverlayPositioning} */ ( - this.get(ol.OverlayProperty.POSITIONING)); + this.get(ol.Overlay.Property.POSITIONING)); }; @@ -303,7 +291,7 @@ ol.Overlay.prototype.handleOffsetChanged = function() { */ ol.Overlay.prototype.handlePositionChanged = function() { this.updatePixelPosition(); - if (this.get(ol.OverlayProperty.POSITION) !== undefined && this.autoPan) { + if (this.get(ol.Overlay.Property.POSITION) !== undefined && this.autoPan) { this.panIntoView_(); } }; @@ -324,7 +312,7 @@ ol.Overlay.prototype.handlePositioningChanged = function() { * @api stable */ ol.Overlay.prototype.setElement = function(element) { - this.set(ol.OverlayProperty.ELEMENT, element); + this.set(ol.Overlay.Property.ELEMENT, element); }; @@ -335,7 +323,7 @@ ol.Overlay.prototype.setElement = function(element) { * @api stable */ ol.Overlay.prototype.setMap = function(map) { - this.set(ol.OverlayProperty.MAP, map); + this.set(ol.Overlay.Property.MAP, map); }; @@ -346,7 +334,7 @@ ol.Overlay.prototype.setMap = function(map) { * @api stable */ ol.Overlay.prototype.setOffset = function(offset) { - this.set(ol.OverlayProperty.OFFSET, offset); + this.set(ol.Overlay.Property.OFFSET, offset); }; @@ -359,7 +347,7 @@ ol.Overlay.prototype.setOffset = function(offset) { * @api stable */ ol.Overlay.prototype.setPosition = function(position) { - this.set(ol.OverlayProperty.POSITION, position); + this.set(ol.Overlay.Property.POSITION, position); }; @@ -450,7 +438,7 @@ ol.Overlay.prototype.getRect_ = function(element, size) { * @api stable */ ol.Overlay.prototype.setPositioning = function(positioning) { - this.set(ol.OverlayProperty.POSITIONING, positioning); + this.set(ol.Overlay.Property.POSITIONING, positioning); }; @@ -551,3 +539,15 @@ ol.Overlay.prototype.updateRenderedPosition = function(pixel, mapSize) { this.setVisible(true); }; + + +/** + * @enum {string} + */ +ol.Overlay.Property = { + ELEMENT: 'element', + MAP: 'map', + OFFSET: 'offset', + POSITION: 'position', + POSITIONING: 'positioning' +};