@google/earthengine 1.7.20 → 1.7.21

package/src/image.js

@@ -33,7 +33,7 @@ goog.require('goog.object');
  *   - An ee.Image: returns the argument,
  *   - Nothing: results in an empty transparent image.
  *
- * @param {number|string|Array.<*>|ee.Image|Object=} opt_args
+ * @param {number|string|!Array.<*>|!ee.Image|!Object|null=} opt_args
  *     Constructor argument.
  * @constructor
  * @extends {ee.Element}
@@ -66,7 +66,7 @@ ee.Image = function(opt_args) {
     } else if (Array.isArray(opt_args)) {
       // Make an image out of each element.
       return ee.Image.combine_(goog.array.map(
-          /** @type {Array.<*>} */ (opt_args),
+          /** @type {!Array.<*>} */ (opt_args),
           function(elem) {
             return new ee.Image(/** @type {?} */ (elem));
           }));
@@ -136,18 +136,19 @@ ee.Image.reset = function() {
  * An imperative function that returns information about this image via an
  * AJAX call.
  *
- * @param {function(ee.data.ImageDescription, string=)=} opt_callback
+ * @param {function(!ee.data.ImageDescription, string=)=} opt_callback
  *     An optional callback. If not supplied, the call is made synchronously.
  *     If supplied, will be called with the first parameter if successful and
  *     the second if unsuccessful.
- * @return {ee.data.ImageDescription} A description of the image. Includes:
+ * @return {!ee.data.ImageDescription|undefined} A description of the image, or
+ *     undefined if a callback is specified. Includes:
  *     - bands - a list containing metadata about the bands in the collection.
  *     - properties - a dictionary containing the image's metadata properties.
  * @export
  * @override
  */
 ee.Image.prototype.getInfo = function(opt_callback) {
-  return /** @type {ee.data.ImageDescription} */(
+  return /** @type {!ee.data.ImageDescription|undefined} */(
       ee.Image.base(this, 'getInfo', opt_callback));
 };
 
@@ -215,7 +216,7 @@ ee.Image.prototype.getMap = ee.Image.prototype.getMapId;
  * 10000.
  *
  * Use getThumbURL for RGB visualization formats PNG and JPG.
- * @param {Object} params An object containing download options with the
+ * @param {!Object} params An object containing download options with the
  *     following possible values:
  *   <table>
  *     <tr>
@@ -410,10 +411,10 @@ ee.Image.prototype.getThumbURL = function(params, opt_callback) {
  * Create a 3-band image specifically for visualization. This uses the first
  * band in each image.
  *
- * @param {ee.Image} r The red image.
- * @param {ee.Image} g The green image.
- * @param {ee.Image} b The blue image.
- * @return {ee.Image} The combined image.
+ * @param {!ee.Image} r The red image.
+ * @param {!ee.Image} g The green image.
+ * @param {!ee.Image} b The blue image.
+ * @return {!ee.Image} The combined image.
  * @export
  */
 ee.Image.rgb = function(r, g, b) {
@@ -435,8 +436,8 @@ ee.Image.rgb = function(r, g, b) {
  *
  * This function will promote constant values into constant images.
  *
- * @param {...ee.Image} var_args The images to be combined.
- * @return {ee.Image} The combined image.
+ * @param {...!ee.Image} var_args The images to be combined.
+ * @return {!ee.Image} The combined image.
  * @export
  */
 ee.Image.cat = function(var_args) {
@@ -449,14 +450,14 @@ ee.Image.cat = function(var_args) {
  * Combine all the bands from the given images into a single image, with
  * optional renaming.
  *
- * @param {Array.<ee.Image>} images The images to be combined.
- * @param {Array.<string>=} opt_names A list of names for the output bands.
- * @return {ee.Image} The combined image.
+ * @param {!Array.<!ee.Image>} images The images to be combined.
+ * @param {?Array.<string>=} opt_names A list of names for the output bands.
+ * @return {!ee.Image} The combined image.
  * @private
  */
 ee.Image.combine_ = function(images, opt_names) {
   if (images.length == 0) {
-    return /** @type {ee.Image} */ (ee.ApiFunction._call('Image.constant', []));
+    return /** @type {!ee.Image} */ (ee.ApiFunction._call('Image.constant', []));
   }
 
   // Append all the bands.
@@ -542,7 +543,7 @@ ee.Image.prototype.select = function(var_args) {
  * using the '=' operator (e.g.: x = a + b).
  *
  * @param {string} expression The expression to evaluate.
- * @param {Object.<ee.Image>=} opt_map A map of input images available by name.
+ * @param {!Object.<!ee.Image>=} opt_map A map of input images available by name.
  * @return {!ee.Image} The image computed by the provided expression.
  * @export
  */
@@ -580,7 +581,7 @@ ee.Image.prototype.expression = function(expression, opt_map) {
 
   /**
    * @this {ee.Function}
-   * @return {ee.Function.Signature}
+   * @return {!ee.Function.Signature}
    */
   func.getSignature = function() {
     return {
@@ -610,9 +611,9 @@ ee.Image.prototype.expression = function(expression, opt_map) {
  *
  * Use clipToCollection to clip an image to a FeatureCollection.
  *
- * @param {ee.Geometry|ee.Feature|Object} geometry
+ * @param {!ee.Geometry|!ee.Feature|!Object} geometry
  *     The Geometry or Feature to clip to.
- * @return {ee.Image} The clipped image.
+ * @return {!ee.Image} The clipped image.
  * @export
  */
 ee.Image.prototype.clip = function(geometry) {
@@ -623,7 +624,7 @@ ee.Image.prototype.clip = function(geometry) {
   } catch (e) {
     // Not an ee.Geometry or GeoJSON. Just pass it along.
   }
-  return /** @type {ee.Image} */(
+  return /** @type {!ee.Image} */(
       ee.ApiFunction._call('Image.clip', this, geometry));
 };
 
@@ -631,9 +632,9 @@ ee.Image.prototype.clip = function(geometry) {
 /**
  * Rename the bands of an image.
  *
- * @param {...string|Object|Array<string>} var_args The new names for the bands.
+ * @param {...string|!Object|!Array<string>} var_args The new names for the bands.
  *    Must match the number of bands in the Image.
- * @return {ee.Image} The renamed image.
+ * @return {!ee.Image} The renamed image.
  * @export
  */
 ee.Image.prototype.rename = function(var_args) {
@@ -645,12 +646,15 @@ ee.Image.prototype.rename = function(var_args) {
     // Varargs list of strings.
     names = Array.from(arguments);
   }
-  return /** @type {ee.Image} */(
+  return /** @type {!ee.Image} */(
       ee.ApiFunction._call('Image.rename', this, names));
 };
 
 
-/** @override */
+/**
+ * @return {string}
+ * @override
+ */
 ee.Image.prototype.name = function() {
   return 'Image';
 };

package/src/images.js

@@ -344,9 +344,9 @@ ee.data.images.applyVisualization = function(image, params) {
  * @return {!ee.data.ImageVisualizationParameters} Params for visualize()
  */
 ee.data.images.extractVisParams = function(params, outParams) {
-  var keysToExtract = ["bands", "gain", "bias", "min", "max",
+  const keysToExtract = ["bands", "gain", "bias", "min", "max",
       "gamma", "palette", "opacity", "forceRgbOutput"];
-  var visParams = {};
+  const visParams = {};
   goog.object.forEach(params, function(value, key) {
     if (goog.array.contains(keysToExtract, key)) {
       visParams[key] = value;

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;