@cesium/engine 2.0.0 → 2.2.0

package/Source/Scene/IonImageryProvider.js

@@ -1,7 +1,7 @@
 import Check from "../Core/Check.js";
 import defaultValue from "../Core/defaultValue.js";
 import defined from "../Core/defined.js";
-import DeveloperError from "../Core/DeveloperError.js";
+import deprecationWarning from "../Core/deprecationWarning.js";
 import Event from "../Core/Event.js";
 import IonResource from "../Core/IonResource.js";
 import RuntimeError from "../Core/RuntimeError.js";
@@ -35,17 +35,59 @@ const ImageryProviderMapping = {
   WMTS: createFactory(WebMapTileServiceImageryProvider),
 };
 
+const ImageryProviderAsyncMapping = {
+  ARCGIS_MAPSERVER: ArcGisMapServerImageryProvider.fromUrl,
+  BING: async (url, options) => {
+    return BingMapsImageryProvider.fromUrl(url, options);
+  },
+  GOOGLE_EARTH: async (url, options) => {
+    const channel = options.channel;
+    delete options.channel;
+    return GoogleEarthEnterpriseMapsProvider.fromUrl(url, channel, options);
+  },
+  MAPBOX: (url, options) => {
+    return new MapboxImageryProvider({
+      url: url,
+      ...options,
+    });
+  },
+  SINGLE_TILE: SingleTileImageryProvider.fromUrl,
+  TMS: TileMapServiceImageryProvider.fromUrl,
+  URL_TEMPLATE: (url, options) => {
+    return new UrlTemplateImageryProvider({
+      url: url,
+      ...options,
+    });
+  },
+  WMS: (url, options) => {
+    return new WebMapServiceImageryProvider({
+      url: url,
+      ...options,
+    });
+  },
+  WMTS: (url, options) => {
+    return new WebMapTileServiceImageryProvider({
+      url: url,
+      ...options,
+    });
+  },
+};
+
 /**
- * @typedef {Object} IonImageryProvider.ConstructorOptions
+ * @typedef {object} IonImageryProvider.ConstructorOptions
  *
  * Initialization options for the TileMapServiceImageryProvider constructor
  *
- * @property {Number} assetId An ion imagery asset ID
- * @property {String} [accessToken=Ion.defaultAccessToken] The access token to use.
- * @property {String|Resource} [server=Ion.defaultServer] The resource to the Cesium ion API server.
+ * @property {number} [assetId] An ion imagery asset ID. Deprecated.
+ * @property {string} [accessToken=Ion.defaultAccessToken] The access token to use.
+ * @property {string|Resource} [server=Ion.defaultServer] The resource to the Cesium ion API server.
  */
 
 /**
+ * <div class="notice">
+ * To construct a IonImageryProvider, call {@link IonImageryProvider.fromAssetId}. Do not call the constructor directly.
+ * </div>
+ *
  * Provides tiled imagery using the Cesium ion REST API.
  *
  * @alias IonImageryProvider
@@ -54,179 +96,54 @@ const ImageryProviderMapping = {
  * @param {IonImageryProvider.ConstructorOptions} options Object describing initialization options
  *
  * @example
- * viewer.imageryLayers.addImageryProvider(new Cesium.IonImageryProvider({ assetId : 23489024 }));
+ * const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
+ * viewer.imageryLayers.add(imageryLayer);
+ *
+ * @see IonImageryProvider.fromAssetId
  */
 function IonImageryProvider(options) {
   options = defaultValue(options, defaultValue.EMPTY_OBJECT);
 
-  const assetId = options.assetId;
-  //>>includeStart('debug', pragmas.debug);
-  Check.typeOf.number("options.assetId", assetId);
-  //>>includeEnd('debug');
-
-  /**
-   * The default alpha blending value of this provider, with 0.0 representing fully transparent and
-   * 1.0 representing fully opaque.
-   *
-   * @type {Number|undefined}
-   * @default undefined
-   */
-  this.defaultAlpha = undefined;
-
-  /**
-   * The default alpha blending value on the night side of the globe of this provider, with 0.0 representing fully transparent and
-   * 1.0 representing fully opaque.
-   *
-   * @type {Number|undefined}
-   * @default undefined
-   */
-  this.defaultNightAlpha = undefined;
-
-  /**
-   * The default alpha blending value on the day side of the globe of this provider, with 0.0 representing fully transparent and
-   * 1.0 representing fully opaque.
-   *
-   * @type {Number|undefined}
-   * @default undefined
-   */
-  this.defaultDayAlpha = undefined;
-
-  /**
-   * The default brightness of this provider.  1.0 uses the unmodified imagery color.  Less than 1.0
-   * makes the imagery darker while greater than 1.0 makes it brighter.
-   *
-   * @type {Number|undefined}
-   * @default undefined
-   */
-  this.defaultBrightness = undefined;
-
-  /**
-   * The default contrast of this provider.  1.0 uses the unmodified imagery color.  Less than 1.0 reduces
-   * the contrast while greater than 1.0 increases it.
-   *
-   * @type {Number|undefined}
-   * @default undefined
-   */
-  this.defaultContrast = undefined;
-
-  /**
-   * The default hue of this provider in radians. 0.0 uses the unmodified imagery color.
-   *
-   * @type {Number|undefined}
-   * @default undefined
-   */
-  this.defaultHue = undefined;
-
-  /**
-   * The default saturation of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 reduces the
-   * saturation while greater than 1.0 increases it.
-   *
-   * @type {Number|undefined}
-   * @default undefined
-   */
-  this.defaultSaturation = undefined;
-
-  /**
-   * The default gamma correction to apply to this provider.  1.0 uses the unmodified imagery color.
-   *
-   * @type {Number|undefined}
-   * @default undefined
-   */
-  this.defaultGamma = undefined;
-
-  /**
-   * The default texture minification filter to apply to this provider.
-   *
-   * @type {TextureMinificationFilter}
-   * @default undefined
-   */
-  this.defaultMinificationFilter = undefined;
-
-  /**
-   * The default texture magnification filter to apply to this provider.
-   *
-   * @type {TextureMagnificationFilter}
-   * @default undefined
-   */
-  this.defaultMagnificationFilter = undefined;
+  this._defaultAlpha = undefined;
+  this._defaultNightAlpha = undefined;
+  this._defaultDayAlpha = undefined;
+  this._defaultBrightness = undefined;
+  this._defaultContrast = undefined;
+  this._defaultHue = undefined;
+  this._defaultSaturation = undefined;
+  this._defaultGamma = undefined;
+  this._defaultMinificationFilter = undefined;
+  this._defaultMagnificationFilter = undefined;
 
   this._ready = false;
   this._tileCredits = undefined;
   this._errorEvent = new Event();
 
-  const that = this;
-  const endpointResource = IonResource._createEndpointResource(
-    assetId,
-    options
-  );
-
-  // A simple cache to avoid making repeated requests to ion for endpoints we've
-  // already retrieved. This exists mainly to support Bing caching to reduce
-  // world imagery sessions, but provides a small boost of performance in general
-  // if constantly reloading assets
-  const cacheKey =
-    options.assetId.toString() + options.accessToken + options.server;
-  let promise = IonImageryProvider._endpointCache[cacheKey];
-  if (!defined(promise)) {
-    promise = endpointResource.fetchJson();
-    IonImageryProvider._endpointCache[cacheKey] = promise;
-  }
-
-  this._readyPromise = promise.then(function (endpoint) {
-    if (endpoint.type !== "IMAGERY") {
-      return Promise.reject(
-        new RuntimeError(`Cesium ion asset ${assetId} is not an imagery asset.`)
-      );
-    }
-
-    let imageryProvider;
-    const externalType = endpoint.externalType;
-    if (!defined(externalType)) {
-      imageryProvider = new TileMapServiceImageryProvider({
-        url: new IonResource(endpoint, endpointResource),
-      });
-    } else {
-      const factory = ImageryProviderMapping[externalType];
-
-      if (!defined(factory)) {
-        return Promise.reject(
-          new RuntimeError(
-            `Unrecognized Cesium ion imagery type: ${externalType}`
-          )
-        );
-      }
-      imageryProvider = factory(endpoint.options);
-    }
-
-    that._tileCredits = IonResource.getCreditsFromEndpoint(
-      endpoint,
-      endpointResource
+  const assetId = options.assetId;
+  if (defined(assetId)) {
+    deprecationWarning(
+      "IonImageryProvider options.assetId",
+      "options.assetId was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use IonImageryProvider.fromAssetId instead."
     );
 
-    imageryProvider.errorEvent.addEventListener(function (tileProviderError) {
-      //Propagate the errorEvent but set the provider to this instance instead
-      //of the inner instance.
-      tileProviderError.provider = that;
-      that._errorEvent.raiseEvent(tileProviderError);
-    });
-
-    that._imageryProvider = imageryProvider;
-    return imageryProvider.readyPromise.then(function () {
-      that._ready = true;
-      return true;
-    });
-  });
+    IonImageryProvider._initialize(this, assetId, options);
+  }
 }
 
 Object.defineProperties(IonImageryProvider.prototype, {
   /**
    * Gets a value indicating whether or not the provider is ready for use.
    * @memberof IonImageryProvider.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
+   * @deprecated
    */
   ready: {
     get: function () {
+      deprecationWarning(
+        "IonImageryProvider.ready",
+        "IonImageryProvider.ready was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use IonImageryProvider.fromAssetId instead."
+      );
       return this._ready;
     },
   },
@@ -234,135 +151,92 @@ Object.defineProperties(IonImageryProvider.prototype, {
   /**
    * Gets a promise that resolves to true when the provider is ready for use.
    * @memberof IonImageryProvider.prototype
-   * @type {Promise.<Boolean>}
+   * @type {Promise<boolean>}
    * @readonly
+   * @deprecated
    */
   readyPromise: {
     get: function () {
+      deprecationWarning(
+        "IonImageryProvider.readyPromise",
+        "IonImageryProvider.readyPromise was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use IonImageryProvider.fromAssetId instead."
+      );
       return this._readyPromise;
     },
   },
 
   /**
-   * Gets the rectangle, in radians, of the imagery provided by the instance.  This function should
-   * not be called before {@link IonImageryProvider#ready} returns true.
+   * Gets the rectangle, in radians, of the imagery provided by the instance.
    * @memberof IonImageryProvider.prototype
    * @type {Rectangle}
    * @readonly
    */
   rectangle: {
     get: function () {
-      //>>includeStart('debug', pragmas.debug);
-      if (!this._ready) {
-        throw new DeveloperError(
-          "tileHeight must not be called before the imagery provider is ready."
-        );
-      }
-      //>>includeEnd('debug');
       return this._imageryProvider.rectangle;
     },
   },
 
   /**
-   * Gets the width of each tile, in pixels.  This function should
-   * not be called before {@link IonImageryProvider#ready} returns true.
+   * Gets the width of each tile, in pixels.
    * @memberof IonImageryProvider.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   tileWidth: {
     get: function () {
-      //>>includeStart('debug', pragmas.debug);
-      if (!this._ready) {
-        throw new DeveloperError(
-          "tileWidth must not be called before the imagery provider is ready."
-        );
-      }
-      //>>includeEnd('debug');
       return this._imageryProvider.tileWidth;
     },
   },
 
   /**
-   * Gets the height of each tile, in pixels.  This function should
-   * not be called before {@link IonImageryProvider#ready} returns true.
+   * Gets the height of each tile, in pixels.
    * @memberof IonImageryProvider.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   tileHeight: {
     get: function () {
-      //>>includeStart('debug', pragmas.debug);
-      if (!this._ready) {
-        throw new DeveloperError(
-          "tileHeight must not be called before the imagery provider is ready."
-        );
-      }
-      //>>includeEnd('debug');
       return this._imageryProvider.tileHeight;
     },
   },
 
   /**
-   * Gets the maximum level-of-detail that can be requested.  This function should
-   * not be called before {@link IonImageryProvider#ready} returns true.
+   * Gets the maximum level-of-detail that can be requested.
    * @memberof IonImageryProvider.prototype
-   * @type {Number|undefined}
+   * @type {number|undefined}
    * @readonly
    */
   maximumLevel: {
     get: function () {
-      //>>includeStart('debug', pragmas.debug);
-      if (!this._ready) {
-        throw new DeveloperError(
-          "maximumLevel must not be called before the imagery provider is ready."
-        );
-      }
-      //>>includeEnd('debug');
       return this._imageryProvider.maximumLevel;
     },
   },
 
   /**
-   * Gets the minimum level-of-detail that can be requested.  This function should
-   * not be called before {@link IonImageryProvider#ready} returns true. Generally,
+   * Gets the minimum level-of-detail that can be requested. Generally,
    * a minimum level should only be used when the rectangle of the imagery is small
    * enough that the number of tiles at the minimum level is small.  An imagery
    * provider with more than a few tiles at the minimum level will lead to
    * rendering problems.
    * @memberof IonImageryProvider.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   minimumLevel: {
     get: function () {
-      //>>includeStart('debug', pragmas.debug);
-      if (!this._ready) {
-        throw new DeveloperError(
-          "minimumLevel must not be called before the imagery provider is ready."
-        );
-      }
-      //>>includeEnd('debug');
       return this._imageryProvider.minimumLevel;
     },
   },
 
   /**
-   * Gets the tiling scheme used by the provider.  This function should
-   * not be called before {@link IonImageryProvider#ready} returns true.
+   * Gets the tiling scheme used by the provider.
    * @memberof IonImageryProvider.prototype
    * @type {TilingScheme}
    * @readonly
    */
   tilingScheme: {
     get: function () {
-      //>>includeStart('debug', pragmas.debug);
-      if (!this._ready) {
-        throw new DeveloperError(
-          "tilingScheme must not be called before the imagery provider is ready."
-        );
-      }
-      //>>includeEnd('debug');
       return this._imageryProvider.tilingScheme;
     },
   },
@@ -370,21 +244,13 @@ Object.defineProperties(IonImageryProvider.prototype, {
   /**
    * Gets the tile discard policy.  If not undefined, the discard policy is responsible
    * for filtering out "missing" tiles via its shouldDiscardImage function.  If this function
-   * returns undefined, no tiles are filtered.  This function should
-   * not be called before {@link IonImageryProvider#ready} returns true.
+   * returns undefined, no tiles are filtered.
    * @memberof IonImageryProvider.prototype
    * @type {TileDiscardPolicy}
    * @readonly
    */
   tileDiscardPolicy: {
     get: function () {
-      //>>includeStart('debug', pragmas.debug);
-      if (!this._ready) {
-        throw new DeveloperError(
-          "tileDiscardPolicy must not be called before the imagery provider is ready."
-        );
-      }
-      //>>includeEnd('debug');
       return this._imageryProvider.tileDiscardPolicy;
     },
   },
@@ -405,21 +271,13 @@ Object.defineProperties(IonImageryProvider.prototype, {
 
   /**
    * Gets the credit to display when this imagery provider is active.  Typically this is used to credit
-   * the source of the imagery. This function should
-   * not be called before {@link IonImageryProvider#ready} returns true.
+   * the source of the imagery.
    * @memberof IonImageryProvider.prototype
    * @type {Credit}
    * @readonly
    */
   credit: {
     get: function () {
-      //>>includeStart('debug', pragmas.debug);
-      if (!this._ready) {
-        throw new DeveloperError(
-          "credit must not be called before the imagery provider is ready."
-        );
-      }
-      //>>includeEnd('debug');
       return this._imageryProvider.credit;
     },
   },
@@ -431,18 +289,11 @@ Object.defineProperties(IonImageryProvider.prototype, {
    * as if their alpha is 1.0 everywhere.  When this property is false, memory usage
    * and texture upload time are reduced.
    * @memberof IonImageryProvider.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   hasAlphaChannel: {
     get: function () {
-      //>>includeStart('debug', pragmas.debug);
-      if (!this._ready) {
-        throw new DeveloperError(
-          "hasAlphaChannel must not be called before the imagery provider is ready."
-        );
-      }
-      //>>includeEnd('debug');
       return this._imageryProvider.hasAlphaChannel;
     },
 
@@ -459,28 +310,404 @@ Object.defineProperties(IonImageryProvider.prototype, {
       },
     },
   },
+
+  /**
+   * The default alpha blending value of this provider, with 0.0 representing fully transparent and
+   * 1.0 representing fully opaque.
+   * @memberof IonImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultAlpha: {
+    get: function () {
+      deprecationWarning(
+        "IonImageryProvider.defaultAlpha",
+        "IonImageryProvider.defaultAlpha was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.alpha instead."
+      );
+      return this._defaultAlpha;
+    },
+    set: function (value) {
+      deprecationWarning(
+        "IonImageryProvider.defaultAlpha",
+        "IonImageryProvider.defaultAlpha was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.alpha instead."
+      );
+      this._defaultAlpha = value;
+    },
+  },
+
+  /**
+   * The default alpha blending value on the night side of the globe of this provider, with 0.0 representing fully transparent and
+   * 1.0 representing fully opaque.
+   * @memberof IonImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultNightAlpha: {
+    get: function () {
+      deprecationWarning(
+        "IonImageryProvider.defaultNightAlpha",
+        "IonImageryProvider.defaultNightAlpha was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.nightAlpha instead."
+      );
+      return this.defaultNightAlpha;
+    },
+    set: function (value) {
+      deprecationWarning(
+        "IonImageryProvider.defaultNightAlpha",
+        "IonImageryProvider.defaultNightAlpha was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.nightAlpha instead."
+      );
+      this.defaultNightAlpha = value;
+    },
+  },
+
+  /**
+   * The default alpha blending value on the day side of the globe of this provider, with 0.0 representing fully transparent and
+   * 1.0 representing fully opaque.
+   * @memberof IonImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultDayAlpha: {
+    get: function () {
+      deprecationWarning(
+        "IonImageryProvider.defaultDayAlpha",
+        "IonImageryProvider.defaultDayAlpha was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.dayAlpha instead."
+      );
+      return this._defaultDayAlpha;
+    },
+    set: function (value) {
+      deprecationWarning(
+        "IonImageryProvider.defaultDayAlpha",
+        "IonImageryProvider.defaultDayAlpha was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.dayAlpha instead."
+      );
+      this._defaultDayAlpha = value;
+    },
+  },
+
+  /**
+   * The default brightness of this provider.  1.0 uses the unmodified imagery color.  Less than 1.0
+   * makes the imagery darker while greater than 1.0 makes it brighter.
+   * @memberof IonImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultBrightness: {
+    get: function () {
+      deprecationWarning(
+        "IonImageryProvider.defaultBrightness",
+        "IonImageryProvider.defaultBrightness was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.brightness instead."
+      );
+      return this._defaultBrightness;
+    },
+    set: function (value) {
+      deprecationWarning(
+        "IonImageryProvider.defaultBrightness",
+        "IonImageryProvider.defaultBrightness was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.brightness instead."
+      );
+      this._defaultBrightness = value;
+    },
+  },
+
+  /**
+   * The default contrast of this provider.  1.0 uses the unmodified imagery color.  Less than 1.0 reduces
+   * the contrast while greater than 1.0 increases it.
+   * @memberof IonImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultContrast: {
+    get: function () {
+      deprecationWarning(
+        "IonImageryProvider.defaultContrast",
+        "IonImageryProvider.defaultContrast was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.contrast instead."
+      );
+      return this._defaultContrast;
+    },
+    set: function (value) {
+      deprecationWarning(
+        "IonImageryProvider.defaultContrast",
+        "IonImageryProvider.defaultContrast was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.contrast instead."
+      );
+      this._defaultContrast = value;
+    },
+  },
+
+  /**
+   * The default hue of this provider in radians. 0.0 uses the unmodified imagery color.
+   * @memberof IonImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultHue: {
+    get: function () {
+      deprecationWarning(
+        "IonImageryProvider.defaultHue",
+        "IonImageryProvider.defaultHue was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.hue instead."
+      );
+      return this._defaultHue;
+    },
+    set: function (value) {
+      deprecationWarning(
+        "IonImageryProvider.defaultHue",
+        "IonImageryProvider.defaultHue was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.hue instead."
+      );
+      this._defaultHue = value;
+    },
+  },
+
+  /**
+   * The default saturation of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 reduces the
+   * saturation while greater than 1.0 increases it.
+   * @memberof IonImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultSaturation: {
+    get: function () {
+      deprecationWarning(
+        "IonImageryProvider.defaultSaturation",
+        "IonImageryProvider.defaultSaturation was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.saturation instead."
+      );
+      return this._defaultSaturation;
+    },
+    set: function (value) {
+      deprecationWarning(
+        "IonImageryProvider.defaultSaturation",
+        "IonImageryProvider.defaultSaturation was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.saturation instead."
+      );
+      this._defaultSaturation = value;
+    },
+  },
+
+  /**
+   * The default gamma correction to apply to this provider.  1.0 uses the unmodified imagery color.
+   * @memberof IonImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultGamma: {
+    get: function () {
+      deprecationWarning(
+        "IonImageryProvider.defaultGamma",
+        "IonImageryProvider.defaultGamma was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.gamma instead."
+      );
+      return this._defaultGamma;
+    },
+    set: function (value) {
+      deprecationWarning(
+        "IonImageryProvider.defaultGamma",
+        "IonImageryProvider.defaultGamma was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.gamma instead."
+      );
+      this._defaultGamma = value;
+    },
+  },
+
+  /**
+   * The default texture minification filter to apply to this provider.
+   * @memberof IonImageryProvider.prototype
+   * @type {TextureMinificationFilter}
+   * @deprecated
+   */
+  defaultMinificationFilter: {
+    get: function () {
+      deprecationWarning(
+        "IonImageryProvider.defaultMinificationFilter",
+        "IonImageryProvider.defaultMinificationFilter was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.minificationFilter instead."
+      );
+      return this._defaultMinificationFilter;
+    },
+    set: function (value) {
+      deprecationWarning(
+        "IonImageryProvider.defaultMinificationFilter",
+        "IonImageryProvider.defaultMinificationFilter was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.minificationFilter instead."
+      );
+      this._defaultMinificationFilter = value;
+    },
+  },
+
+  /**
+   * The default texture magnification filter to apply to this provider.
+   * @memberof IonImageryProvider.prototype
+   * @type {TextureMagnificationFilter}
+   * @deprecated
+   */
+  defaultMagnificationFilter: {
+    get: function () {
+      deprecationWarning(
+        "IonImageryProvider.defaultMagnificationFilter",
+        "IonImageryProvider.defaultMagnificationFilter was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.magnificationFilter instead."
+      );
+      return this._defaultMagnificationFilter;
+    },
+    set: function (value) {
+      deprecationWarning(
+        "IonImageryProvider.defaultMagnificationFilter",
+        "IonImageryProvider.defaultMagnificationFilter was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.magnificationFilter instead."
+      );
+      this._defaultMagnificationFilter = value;
+    },
+  },
 });
 
+// This is here for backwards compatibility
+IonImageryProvider._initialize = function (provider, assetId, options) {
+  const endpointResource = IonResource._createEndpointResource(
+    assetId,
+    options
+  );
+
+  // A simple cache to avoid making repeated requests to ion for endpoints we've
+  // already retrieved. This exists mainly to support Bing caching to reduce
+  // world imagery sessions, but provides a small boost of performance in general
+  // if constantly reloading assets
+  const cacheKey = assetId.toString() + options.accessToken + options.server;
+  let promise = IonImageryProvider._endpointCache[cacheKey];
+  if (!defined(promise)) {
+    promise = endpointResource.fetchJson();
+    IonImageryProvider._endpointCache[cacheKey] = promise;
+  }
+
+  provider._readyPromise = promise.then(function (endpoint) {
+    if (endpoint.type !== "IMAGERY") {
+      return Promise.reject(
+        new RuntimeError(`Cesium ion asset ${assetId} is not an imagery asset.`)
+      );
+    }
+
+    let imageryProvider;
+    const externalType = endpoint.externalType;
+    if (!defined(externalType)) {
+      imageryProvider = new TileMapServiceImageryProvider({
+        url: new IonResource(endpoint, endpointResource),
+      });
+    } else {
+      const factory = ImageryProviderMapping[externalType];
+
+      if (!defined(factory)) {
+        return Promise.reject(
+          new RuntimeError(
+            `Unrecognized Cesium ion imagery type: ${externalType}`
+          )
+        );
+      }
+      imageryProvider = factory(endpoint.options);
+    }
+
+    provider._tileCredits = IonResource.getCreditsFromEndpoint(
+      endpoint,
+      endpointResource
+    );
+
+    imageryProvider.errorEvent.addEventListener(function (tileProviderError) {
+      //Propagate the errorEvent but set the provider to this instance instead
+      //of the inner instance.
+      tileProviderError.provider = provider;
+      provider._errorEvent.raiseEvent(tileProviderError);
+    });
+
+    provider._imageryProvider = imageryProvider;
+    // readyPromise is deprecated. This is here for backwards compatibility
+    return Promise.resolve(imageryProvider._readyPromise).then(function () {
+      provider._ready = true;
+      return true;
+    });
+  });
+};
+
 /**
- * Gets the credits to be displayed when a given tile is displayed.
- * @function
+ * Creates a provider for tiled imagery using the Cesium ion REST API.
  *
- * @param {Number} x The tile X coordinate.
- * @param {Number} y The tile Y coordinate.
- * @param {Number} level The tile level;
- * @returns {Credit[]} The credits to be displayed when the tile is displayed.
+ * @param {Number} assetId  An ion imagery asset ID.
+ * @param {IonImageryProvider.ConstructorOptions} options Object describing initialization options.
+ * @returns {Promise<IonImageryProvider>} A promise which resolves to the created IonImageryProvider.
  *
- * @exception {DeveloperError} <code>getTileCredits</code> must not be called before the imagery provider is ready.
+ * @example
+ * const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
+ * viewer.imageryLayers.add(imageryLayer);
+ *
+ * @exception {RuntimeError} Cesium ion assetId is not an imagery asset
+ * @exception {RuntimeError} Unrecognized Cesium ion imagery type
  */
-IonImageryProvider.prototype.getTileCredits = function (x, y, level) {
+IonImageryProvider.fromAssetId = async function (assetId, options) {
   //>>includeStart('debug', pragmas.debug);
-  if (!this._ready) {
-    throw new DeveloperError(
-      "getTileCredits must not be called before the imagery provider is ready."
+  Check.typeOf.number("assetId", assetId);
+  //>>includeEnd('debug');
+
+  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  const endpointResource = IonResource._createEndpointResource(
+    assetId,
+    options
+  );
+
+  // A simple cache to avoid making repeated requests to ion for endpoints we've
+  // already retrieved. This exists mainly to support Bing caching to reduce
+  // world imagery sessions, but provides a small boost of performance in general
+  // if constantly reloading assets
+  const cacheKey = assetId.toString() + options.accessToken + options.server;
+  let promise = IonImageryProvider._endpointCache[cacheKey];
+  if (!defined(promise)) {
+    promise = endpointResource.fetchJson();
+    IonImageryProvider._endpointCache[cacheKey] = promise;
+  }
+
+  const endpoint = await promise;
+  if (endpoint.type !== "IMAGERY") {
+    throw new RuntimeError(
+      `Cesium ion asset ${assetId} is not an imagery asset.`
     );
   }
-  //>>includeEnd('debug');
 
+  let imageryProvider;
+  const externalType = endpoint.externalType;
+  if (!defined(externalType)) {
+    imageryProvider = await TileMapServiceImageryProvider.fromUrl(
+      new IonResource(endpoint, endpointResource)
+    );
+  } else {
+    const factory = ImageryProviderAsyncMapping[externalType];
+
+    if (!defined(factory)) {
+      throw new RuntimeError(
+        `Unrecognized Cesium ion imagery type: ${externalType}`
+      );
+    }
+    // Make a copy before editing since this object reference is cached;
+    const options = { ...endpoint.options };
+    const url = options.url;
+    delete options.url;
+    imageryProvider = await factory(url, options);
+  }
+
+  const provider = new IonImageryProvider(options);
+
+  imageryProvider.errorEvent.addEventListener(function (tileProviderError) {
+    //Propagate the errorEvent but set the provider to this instance instead
+    //of the inner instance.
+    tileProviderError.provider = provider;
+    provider._errorEvent.raiseEvent(tileProviderError);
+  });
+
+  provider._tileCredits = IonResource.getCreditsFromEndpoint(
+    endpoint,
+    endpointResource
+  );
+
+  provider._imageryProvider = imageryProvider;
+  provider._ready = true;
+  provider._readyPromise = Promise.resolve(true);
+
+  return provider;
+};
+
+/**
+ * Gets the credits to be displayed when a given tile is displayed.
+ * @function
+ *
+ * @param {number} x The tile X coordinate.
+ * @param {number} y The tile Y coordinate.
+ * @param {number} level The tile level;
+ * @returns {Credit[]} The credits to be displayed when the tile is displayed.
+ */
+IonImageryProvider.prototype.getTileCredits = function (x, y, level) {
   const innerCredits = this._imageryProvider.getTileCredits(x, y, level);
   if (!defined(innerCredits)) {
     return this._tileCredits;
@@ -490,48 +717,35 @@ IonImageryProvider.prototype.getTileCredits = function (x, y, level) {
 };
 
 /**
- * Requests the image for a given tile.  This function should
- * not be called before {@link IonImageryProvider#ready} returns true.
+ * Requests the image for a given tile.
  * @function
  *
- * @param {Number} x The tile X coordinate.
- * @param {Number} y The tile Y coordinate.
- * @param {Number} level The tile level.
+ * @param {number} x The tile X coordinate.
+ * @param {number} y The tile Y coordinate.
+ * @param {number} level The tile level.
  * @param {Request} [request] The request object. Intended for internal use only.
- * @returns {Promise.<ImageryTypes>|undefined} A promise for the image that will resolve when the image is available, or
+ * @returns {Promise<ImageryTypes>|undefined} A promise for the image that will resolve when the image is available, or
  *          undefined if there are too many active requests to the server, and the request should be retried later.
- *
- * @exception {DeveloperError} <code>requestImage</code> must not be called before the imagery provider is ready.
  */
 IonImageryProvider.prototype.requestImage = function (x, y, level, request) {
-  //>>includeStart('debug', pragmas.debug);
-  if (!this._ready) {
-    throw new DeveloperError(
-      "requestImage must not be called before the imagery provider is ready."
-    );
-  }
-  //>>includeEnd('debug');
   return this._imageryProvider.requestImage(x, y, level, request);
 };
 
 /**
  * Asynchronously determines what features, if any, are located at a given longitude and latitude within
- * a tile.  This function should not be called before {@link IonImageryProvider#ready} returns true.
- * This function is optional, so it may not exist on all ImageryProviders.
+ * a tile. This function is optional, so it may not exist on all ImageryProviders.
  *
  * @function
  *
- * @param {Number} x The tile X coordinate.
- * @param {Number} y The tile Y coordinate.
- * @param {Number} level The tile level.
- * @param {Number} longitude The longitude at which to pick features.
- * @param {Number} latitude  The latitude at which to pick features.
- * @return {Promise.<ImageryLayerFeatureInfo[]>|undefined} A promise for the picked features that will resolve when the asynchronous
+ * @param {number} x The tile X coordinate.
+ * @param {number} y The tile Y coordinate.
+ * @param {number} level The tile level.
+ * @param {number} longitude The longitude at which to pick features.
+ * @param {number} latitude  The latitude at which to pick features.
+ * @return {Promise<ImageryLayerFeatureInfo[]>|undefined} A promise for the picked features that will resolve when the asynchronous
  *                   picking completes.  The resolved value is an array of {@link ImageryLayerFeatureInfo}
  *                   instances.  The array may be empty if no features are found at the given location.
  *                   It may also be undefined if picking is not supported.
- *
- * @exception {DeveloperError} <code>pickFeatures</code> must not be called before the imagery provider is ready.
  */
 IonImageryProvider.prototype.pickFeatures = function (
   x,
@@ -540,13 +754,6 @@ IonImageryProvider.prototype.pickFeatures = function (
   longitude,
   latitude
 ) {
-  //>>includeStart('debug', pragmas.debug);
-  if (!this._ready) {
-    throw new DeveloperError(
-      "pickFeatures must not be called before the imagery provider is ready."
-    );
-  }
-  //>>includeEnd('debug');
   return this._imageryProvider.pickFeatures(x, y, level, longitude, latitude);
 };