@google/earthengine 1.7.19 → 1.7.21

package/src/layers/abstractoverlay.js

@@ -19,8 +19,6 @@ goog.require('goog.net.XhrIo');
 goog.require('goog.object');
 goog.require('goog.structs.Map');
 goog.require('goog.style');
-goog.requireType('ee.data.Profiler');
-
 
 
 /**
@@ -36,7 +34,7 @@ ee.layers.AbstractOverlay = class extends goog.events.EventTarget {
   /**
    * @param {!ee.layers.AbstractTileSource} tileSource The source of tiles
    *     for this map layer.
-   * @param {Object=} opt_options Initialization options, of the same form as a
+   * @param {?Object=} opt_options Initialization options, of the same form as a
    *     google.maps.ImageMapTypeOptions object.
    */
   constructor(tileSource, opt_options) {
@@ -44,7 +42,7 @@ ee.layers.AbstractOverlay = class extends goog.events.EventTarget {
 
     // Public options required by the Maps API.
 
-    var options = opt_options || {};
+    const options = opt_options || {};
     this.minZoom = options.minZoom || 0;
     this.maxZoom = options.maxZoom || 20;
     if (!window['google'] || !window['google']['maps']) {
@@ -63,16 +61,16 @@ ee.layers.AbstractOverlay = class extends goog.events.EventTarget {
     /** @protected {!ee.layers.AbstractOverlayStats} */
     this.stats = new ee.layers.AbstractOverlayStats(tileSource.getUniqueId());
 
-    /** @protected {goog.structs.Map<string, ee.layers.AbstractTile>} */
+    /** @protected {?goog.structs.Map<string, ?ee.layers.AbstractTile>} */
     this.tilesById = new goog.structs.Map();
 
     /** @protected {number} The count of tiles that have been requested. */
     this.tileCounter = 0;
 
-    /** @protected {ee.layers.AbstractTileSource} The overlay's tile source. */
+    /** @protected {?ee.layers.AbstractTileSource} The overlay's tile source. */
     this.tileSource = tileSource;
 
-    /** @protected {goog.events.EventHandler} The overlay's event handler. */
+    /** @protected {?goog.events.EventHandler} The overlay's event handler. */
     this.handler = new goog.events.EventHandler(this);
 
     // MapType options required by the compiler but which we don't support.
@@ -86,7 +84,7 @@ ee.layers.AbstractOverlay = class extends goog.events.EventTarget {
 
   /**
    * Adds a callback to be fired each time a tile is loaded.
-   * @param {function(ee.layers.TileLoadEvent)} callback The function to call.
+   * @param {function(!ee.layers.TileLoadEvent)} callback The function to call.
    * @return {!Object} An ID which can be passed to removeTileCallback().
    * @export
    */
@@ -101,7 +99,7 @@ ee.layers.AbstractOverlay = class extends goog.events.EventTarget {
    * @export
    */
   removeTileCallback(callbackId) {
-    goog.events.unlistenByKey(/** @type {goog.events.Key} */ (callbackId));
+    goog.events.unlistenByKey(/** @type {!goog.events.Key} */ (callbackId));
   }
 
   /**
@@ -153,7 +151,7 @@ ee.layers.AbstractOverlay = class extends goog.events.EventTarget {
    * @return {?Element} Element to be displayed as a map tile.
    */
   getTile(coord, zoom, ownerDocument) {
-    var maxCoord = 1 << zoom;
+    const maxCoord = 1 << zoom;
 
     // If the position is out of bounds, return an empty tile immediately.
     if (zoom < this.minZoom || coord.y < 0 || coord.y >= maxCoord) {
@@ -161,15 +159,15 @@ ee.layers.AbstractOverlay = class extends goog.events.EventTarget {
     }
 
     // Wrap longitude around.
-    var x = coord.x % maxCoord;
+    let x = coord.x % maxCoord;
     if (x < 0) {
       x += maxCoord;
     }
-    var normalizedCoord = new google.maps.Point(x, coord.y);
+    const normalizedCoord = new google.maps.Point(x, coord.y);
 
     // Create the tile.
-    var uniqueId = this.getUniqueTileId_(coord, zoom);
-    var tile = this.createTile(normalizedCoord, zoom, ownerDocument, uniqueId);
+    const uniqueId = this.getUniqueTileId_(coord, zoom);
+    const tile = this.createTile(normalizedCoord, zoom, ownerDocument, uniqueId);
     tile.tileSize = this.tileSize;
     goog.style.setOpacity(tile.div, this.opacity);
     this.tilesById.set(uniqueId, tile);
@@ -188,7 +186,7 @@ ee.layers.AbstractOverlay = class extends goog.events.EventTarget {
     // Requests for tiles that are no longer visible won't clog the queue:
     // if the map is moved around a lot, Maps API calls our releaseTile()
     // method, and the obsolete requests will be removed from the queue.
-    var priority = new Date().getTime() / 1000;
+    const priority = new Date().getTime() / 1000;
 
     this.tileSource.loadTile(tile, priority);
 
@@ -200,7 +198,7 @@ ee.layers.AbstractOverlay = class extends goog.events.EventTarget {
    * Implements releaseTile() for the google.maps.MapType interface.
    */
   releaseTile(tileDiv) {
-    var tile = this.tilesById.get(tileDiv.id);
+    const tile = this.tilesById.get(tileDiv.id);
     this.tilesById.delete(tileDiv.id);
     if (tile) {
       tile.abort();
@@ -210,14 +208,14 @@ ee.layers.AbstractOverlay = class extends goog.events.EventTarget {
 
   /**
    * Listen for tile status changes and respond accordingly.
-   * @param {ee.layers.AbstractTile} tile
+   * @param {!ee.layers.AbstractTile} tile
    * @private
    */
   registerStatusChangeListener_(tile) {
     // Notify listeners when the tile has loaded.
     this.handler.listen(
         tile, ee.layers.AbstractTile.EventType.STATUS_CHANGED, function() {
-          var Status = ee.layers.AbstractTile.Status;
+          const Status = ee.layers.AbstractTile.Status;
 
           switch (tile.getStatus()) {
             case Status.LOADED:
@@ -260,8 +258,8 @@ ee.layers.AbstractOverlay = class extends goog.events.EventTarget {
    * @private
    */
   getUniqueTileId_(coord, z) {
-    var tileId = [coord.x, coord.y, z, this.tileCounter++].join('-');
-    var sourceId = this.tileSource.getUniqueId();
+    const tileId = [coord.x, coord.y, z, this.tileCounter++].join('-');
+    const sourceId = this.tileSource.getUniqueId();
     return [tileId, sourceId].join('-');
   }
 
@@ -278,7 +276,7 @@ ee.layers.AbstractOverlay = class extends goog.events.EventTarget {
 
   /**
    * Returns the count of tiles with the provided status.
-   * @param {ee.layers.AbstractTile.Status} status The tile status.
+   * @param {!ee.layers.AbstractTile.Status} status The tile status.
    * @return {number} The count of tiles with the provided status.
    * @private
    */
@@ -320,9 +318,9 @@ ee.layers.AbstractOverlay.DEFAULT_TILE_EDGE_LENGTH = 256;
  * Factory method to create a tile for this overlay.
  * @param {!google.maps.Point} coord The position of the tile.
  * @param {number} zoom The zoom level of the tile.
- * @param {Node} ownerDocument The owner document.
+ * @param {?Node} ownerDocument The owner document.
  * @param {string} uniqueId
- * @return {ee.layers.AbstractTile}
+ * @return {!ee.layers.AbstractTile}
  * @protected
  */
 ee.layers.AbstractOverlay.prototype.createTile = goog.abstractMethod;
@@ -449,7 +447,7 @@ ee.layers.AbstractTile = class extends goog.events.EventTarget {
   /**
    * @param {!google.maps.Point} coord The position of the tile.
    * @param {number} zoom The zoom level of the tile.
-   * @param {Node} ownerDocument The tile's owner document.
+   * @param {?Node} ownerDocument The tile's owner document.
    * @param {string} uniqueId A unique ID for the tile.
    */
   constructor(coord, zoom, ownerDocument, uniqueId) {
@@ -468,7 +466,7 @@ ee.layers.AbstractTile = class extends goog.events.EventTarget {
     /** @package {number} The maximum number of tile load retries. */
     this.maxRetries = ee.layers.AbstractTile.DEFAULT_MAX_LOAD_RETRIES_;
 
-    /** @package {google.maps.Size} The size of the tile. */
+    /** @package {!google.maps.Size} The size of the tile. */
     this.tileSize;
 
     /** @package {string} The URL of the tile's source data. */
@@ -477,7 +475,7 @@ ee.layers.AbstractTile = class extends goog.events.EventTarget {
     /** @package {!Blob} The source data for the tile. */
     this.sourceData;
 
-    /** @package {Object} The response headers from the source data request. */
+    /** @package {!Object} The response headers from the source data request. */
     this.sourceResponseHeaders;
 
     /**
@@ -486,10 +484,10 @@ ee.layers.AbstractTile = class extends goog.events.EventTarget {
      */
     this.renderer = function() {};  // No-op by default.
 
-    /** @private {goog.net.XhrIo} The request for the tile's source data. */
+    /** @private {!goog.net.XhrIo} The request for the tile's source data. */
     this.xhrIo_;
 
-    /** @private {ee.layers.AbstractTile.Status} The tile's current status. */
+    /** @private {!ee.layers.AbstractTile.Status} The tile's current status. */
     this.status_ = ee.layers.AbstractTile.Status.NEW;
 
     /** @private {number} The current load retry attempt. */
@@ -593,7 +591,7 @@ ee.layers.AbstractTile = class extends goog.events.EventTarget {
    * @package
    */
   retryLoad(opt_errorMessage) {
-    var parseError = function(error) {
+    const parseError = function(error) {
       try {
         error = JSON.parse(error);
         if (error['error'] && error['error']['message']) {
@@ -643,14 +641,14 @@ ee.layers.AbstractTile = class extends goog.events.EventTarget {
     return this.status_ in ee.layers.AbstractTile.DONE_STATUS_SET_;
   }
 
-  /** @package @return {ee.layers.AbstractTile.Status} The tile's status. */
+  /** @package @return {!ee.layers.AbstractTile.Status} The tile's status. */
   getStatus() {
     return this.status_;
   }
 
   /**
    * Sets the tile's status.
-   * @param {ee.layers.AbstractTile.Status} status The new status.
+   * @param {!ee.layers.AbstractTile.Status} status The new status.
    * @package
    */
   setStatus(status) {
@@ -701,7 +699,7 @@ ee.layers.AbstractTile.Status = {
 
 
 
-/** @private @const {!Object<ee.layers.AbstractTile.Status>} */
+/** @private @const {!Object<!ee.layers.AbstractTile.Status>} */
 ee.layers.AbstractTile.DONE_STATUS_SET_ = goog.object.createSet(
     ee.layers.AbstractTile.Status.ABORTED, ee.layers.AbstractTile.Status.FAILED,
     ee.layers.AbstractTile.Status.LOADED,
@@ -709,5 +707,5 @@ ee.layers.AbstractTile.DONE_STATUS_SET_ = goog.object.createSet(
 
 
 
-/** @private {number} The default number of maximum tile load attempts. */
+/** @private @const {number} The default number of maximum tile load attempts. */
 ee.layers.AbstractTile.DEFAULT_MAX_LOAD_RETRIES_ = 5;

package/src/list.js

@@ -43,7 +43,7 @@ ee.List = function(list) {
 
   if (Array.isArray(list)) {
     ee.List.base(this, 'constructor', null, null);
-    this.list_ = /** @type {IArrayLike} */ (list);
+    this.list_ = /** @type {!IArrayLike} */ (list);
   } else if (list instanceof ee.ComputedObject) {
     ee.List.base(this, 'constructor', list.func, list.args, list.varName);
     this.list_ = null;
@@ -79,7 +79,9 @@ ee.List.reset = function() {
 
 
 /**
+ * @param {function(*): *} encoder The function to encode inner objects.
  * @override
+ * @return {*}
  */
 ee.List.prototype.encode = function(encoder) {
   if (Array.isArray(this.list_)) {
@@ -104,6 +106,7 @@ ee.List.prototype.encodeCloudValue = function(
 
 /**
  * @override
+ * @return {string}
  */
 ee.List.prototype.name = function() {
   return 'List';

package/src/maplayeroverlay.js

@@ -30,9 +30,9 @@ ee.MapLayerOverlay =
    * @param {string} url The url for fetching this layer's tiles.
    * @param {string} mapId The map ID for fetching this layer's tiles.
    * @param {string} token The temporary token for fetching tiles.
-   * @param {Object} init Initialization options, of the same form as a
+   * @param {!Object} init Initialization options, of the same form as a
    *     google.maps.ImageMapTypeOptions object.
-   * @param {ee.data.Profiler=} opt_profiler Map tile calculation cost will be
+   * @param {!ee.data.Profiler=} opt_profiler Map tile calculation cost will be
    *     sent to this profiler, if its enabled flag is set.
    */
   constructor(url, mapId, token, init, opt_profiler) {
@@ -48,19 +48,19 @@ ee.MapLayerOverlay =
     this.isPng = (init.isPng !== undefined) ? init.isPng : true;
     this.name = init.name;
 
-    /** @private {goog.structs.Set} The set of loaded tiles. */
+    /** @private @const {!goog.structs.Set} The set of loaded tiles. */
     this.tiles_ = new goog.structs.Set();
 
     /** @private {number} The layer's opacity. */
     this.opacity_ = 1.0;
 
-    /** @private {boolean} Whether the layer is currently visible. */
+    /** @private @const {boolean} Whether the layer is currently visible. */
     this.visible_ = true;
 
     /**
      * Map tile calculation cost will be sent to this profiler, if its enabled
      * flag is set.
-     * @private {?ee.data.Profiler}
+     * @private @const {?ee.data.Profiler}
      */
     this.profiler_ = opt_profiler || null;
   }
@@ -88,7 +88,7 @@ ee.MapLayerOverlay =
    * @export
    */
   removeTileCallback(callbackId) {
-    goog.events.unlistenByKey(/** @type {goog.events.Key} */ (callbackId));
+    goog.events.unlistenByKey(/** @type {!goog.events.Key} */ (callbackId));
   }
 
   /**
@@ -105,23 +105,23 @@ ee.MapLayerOverlay =
    * Implements getTile() for the google.maps.MapType interface.
    * @param {!google.maps.Point} coord Position of tile.
    * @param {number} zoom Zoom level.
-   * @param {Node} ownerDocument Parent document.
-   * @return {Node} Element to be displayed as a map tile.
+   * @param {!Node} ownerDocument Parent document.
+   * @return {!Node} Element to be displayed as a map tile.
    * @override
    */
   getTile(coord, zoom, ownerDocument) {
-    var maxCoord = 1 << zoom;
+    const maxCoord = 1 << zoom;
     if (zoom < this.minZoom || coord.y < 0 || coord.y >= maxCoord) {
       // Construct and return the tile immediately.
-      var img = ownerDocument.createElement('IMG');
+      const img = ownerDocument.createElement('IMG');
       img.style.width = '0px';
       img.style.height = '0px';
       return img;
     }
 
-    var profiling = this.profiler_ && this.profiler_.isEnabled();
-    var tileId = this.getTileId(coord, zoom);
-    var src = [this.url, tileId].join('/') + '?token=' + this.token;
+    const profiling = this.profiler_ && this.profiler_.isEnabled();
+    const tileId = this.getTileId(coord, zoom);
+    let src = [this.url, tileId].join('/') + '?token=' + this.token;
     if (profiling) {
       src += '&profiling=1';
     }
@@ -132,11 +132,11 @@ ee.MapLayerOverlay =
     // don't overwrite each other's state, and 2) the unique token for this
     // layer to differentiate its tile requests from other tile requests
     // for other layers with the same map ID.
-    var uniqueTileId = [tileId, this.tileCounter, this.token].join('/');
+    const uniqueTileId = [tileId, this.tileCounter, this.token].join('/');
     this.tileCounter += 1;
 
     // Holds the <img> element created asynchronously.
-    var div = goog.dom.createDom(goog.dom.TagName.DIV, {'id': uniqueTileId});
+    const div = goog.dom.createDom(goog.dom.TagName.DIV, {'id': uniqueTileId});
 
     // Use the current time in seconds as the priority for the tile
     // loading queue. Smaller priorities move to the front of the queue,
@@ -145,7 +145,7 @@ ee.MapLayerOverlay =
     // Requests for tiles that are no longer visible won't clog the queue:
     // if the map is moved around a lot, Maps API calls our releaseTile()
     // method, and the obsolete requests will be removed from the queue.
-    var priority = new Date().getTime() / 1000;
+    const priority = new Date().getTime() / 1000;
     this.tilesLoading.push(uniqueTileId);
 
     ee.MapTileManager.getInstance().send(
@@ -171,11 +171,11 @@ ee.MapLayerOverlay =
   /**
    * Implements releaseTile() for the google.maps.MapType
    * interface.
-   * @param {Node} tileDiv The tile that has been released.
+   * @param {!Node} tileDiv The tile that has been released.
    */
   releaseTile(tileDiv) {
     ee.MapTileManager.getInstance().abort(tileDiv.id);
-    var tileImg = goog.dom.getFirstElementChild(tileDiv);
+    const tileImg = goog.dom.getFirstElementChild(tileDiv);
     this.tiles_.remove(tileImg);
     if (tileDiv.id !== '') {  // Out-of-bounds tiles have no ID.
       this.tilesFailed.remove(tileDiv.id);
@@ -191,7 +191,7 @@ ee.MapLayerOverlay =
    */
   setOpacity(opacity) {
     this.opacity_ = opacity;
-    var iter = this.tiles_.__iterator__();
+    const iter = this.tiles_.__iterator__();
     goog.iter.forEach(iter, function(tile) {
       goog.style.setOpacity(tile, opacity);
     });
@@ -201,7 +201,7 @@ ee.MapLayerOverlay =
    * Handle image 'load' and 'error' events. When the last one has
    * finished, dispatch an ee.AbstractOverlay.EventType.TILE_LOADED event.
    * Handle bookkeeping to keep the tilesLoading array accurate.
-   * @param {Node} div Tile div to which images should be appended.
+   * @param {!Node} div Tile div to which images should be appended.
    * @param {string} tileId The id of the tile that was requested.
    * @param {!goog.events.Event} e Image loading event.
    * @param {?string} profileId If profiling, profile ID for the tile.
@@ -216,12 +216,12 @@ ee.MapLayerOverlay =
     } else {
       // Convert tile loading events to our own type.
       goog.array.remove(this.tilesLoading, tileId);
-      var tile;
+      let tile;
       if (e.target && (e.type == goog.events.EventType.LOAD)) {
-        tile = /** @type {Node} */ (e.target);
+        tile = /** @type {!Node} */ (e.target);
         this.tiles_.add(tile);
         if (this.opacity_ != 1.0) {
-          goog.style.setOpacity(/** @type {Element} */ (tile), this.opacity_);
+          goog.style.setOpacity(/** @type {!Element} */ (tile), this.opacity_);
         }
         div.appendChild(tile);
       }