@cesium/engine 2.0.0 → 2.2.0

package/Source/Scene/BingMapsImageryProvider.js

@@ -3,7 +3,7 @@ import Check from "../Core/Check.js";
 import Credit from "../Core/Credit.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 CesiumMath from "../Core/Math.js";
 import Rectangle from "../Core/Rectangle.js";
@@ -16,17 +16,17 @@ import DiscardEmptyTilePolicy from "./DiscardEmptyTileImagePolicy.js";
 import ImageryProvider from "./ImageryProvider.js";
 
 /**
- * @typedef {Object} BingMapsImageryProvider.ConstructorOptions
+ * @typedef {object} BingMapsImageryProvider.ConstructorOptions
  *
  * Initialization options for the BingMapsImageryProvider constructor
  *
- * @property {Resource|String} url The url of the Bing Maps server hosting the imagery.
- * @property {String} key The Bing Maps key for your application, which can be
+ * @property {Resource|string} [url] The url of the Bing Maps server hosting the imagery. Deprecated.
+ * @property {string} [key] The Bing Maps key for your application, which can be
  *        created at {@link https://www.bingmapsportal.com/}.
- * @property {String} [tileProtocol] The protocol to use when loading tiles, e.g. 'http' or 'https'.
+ * @property {string} [tileProtocol] The protocol to use when loading tiles, e.g. 'http' or 'https'.
  *        By default, tiles are loaded using the same protocol as the page.
  * @property {BingMapsStyle} [mapStyle=BingMapsStyle.AERIAL] The type of Bing Maps imagery to load.
- * @property {String} [culture=''] The culture to use when requesting Bing Maps imagery. Not
+ * @property {string} [culture=''] The culture to use when requesting Bing Maps imagery. Not
  *        all cultures are supported. See {@link http://msdn.microsoft.com/en-us/library/hh441729.aspx}
  *        for information on the supported cultures.
  * @property {Ellipsoid} [ellipsoid] The ellipsoid.  If not specified, the WGS84 ellipsoid is used.
@@ -37,6 +37,140 @@ import ImageryProvider from "./ImageryProvider.js";
  */
 
 /**
+ * Used to track creation details while fetching initial metadata
+ *
+ * @constructor
+ * @private
+ *
+ * @param {BingMapsImageryProvider.ConstructorOptions} options An object describing initialization options
+ */
+function ImageryProviderBuilder(options) {
+  this.tileWidth = undefined;
+  this.tileHeight = undefined;
+  this.maximumLevel = undefined;
+  this.imageUrlSubdomains = undefined;
+  this.imageUrlTemplate = undefined;
+
+  this.attributionList = undefined;
+}
+
+/**
+ * Complete BingMapsImageryProvider creation based on builder values.
+ *
+ * @private
+ *
+ * @param {BingMapsImageryProvider} provider
+ */
+ImageryProviderBuilder.prototype.build = function (provider) {
+  provider._tileWidth = this.tileWidth;
+  provider._tileHeight = this.tileHeight;
+  provider._maximumLevel = this.maximumLevel;
+  provider._imageUrlSubdomains = this.imageUrlSubdomains;
+  provider._imageUrlTemplate = this.imageUrlTemplate;
+
+  let attributionList = (provider._attributionList = this.attributionList);
+  if (!attributionList) {
+    attributionList = [];
+  }
+  provider._attributionList = attributionList;
+
+  for (
+    let attributionIndex = 0, attributionLength = attributionList.length;
+    attributionIndex < attributionLength;
+    ++attributionIndex
+  ) {
+    const attribution = attributionList[attributionIndex];
+
+    if (attribution.credit instanceof Credit) {
+      // If attribution.credit has already been created
+      // then we are using a cached value, which means
+      // none of the remaining processing needs to be done.
+      break;
+    }
+
+    attribution.credit = new Credit(attribution.attribution);
+    const coverageAreas = attribution.coverageAreas;
+
+    for (
+      let areaIndex = 0, areaLength = attribution.coverageAreas.length;
+      areaIndex < areaLength;
+      ++areaIndex
+    ) {
+      const area = coverageAreas[areaIndex];
+      const bbox = area.bbox;
+      area.bbox = new Rectangle(
+        CesiumMath.toRadians(bbox[1]),
+        CesiumMath.toRadians(bbox[0]),
+        CesiumMath.toRadians(bbox[3]),
+        CesiumMath.toRadians(bbox[2])
+      );
+    }
+  }
+
+  provider._ready = true;
+};
+
+function metadataSuccess(data, imageryProviderBuilder) {
+  if (data.resourceSets.length !== 1) {
+    throw new RuntimeError(
+      "metadata does not specify one resource in resourceSets"
+    );
+  }
+
+  const resource = data.resourceSets[0].resources[0];
+  imageryProviderBuilder.tileWidth = resource.imageWidth;
+  imageryProviderBuilder.tileHeight = resource.imageHeight;
+  imageryProviderBuilder.maximumLevel = resource.zoomMax - 1;
+  imageryProviderBuilder.imageUrlSubdomains = resource.imageUrlSubdomains;
+  imageryProviderBuilder.imageUrlTemplate = resource.imageUrl;
+  imageryProviderBuilder.attributionList = resource.imageryProviders;
+}
+
+function metadataFailure(metadataResource, error, provider) {
+  let message = `An error occurred while accessing ${metadataResource.url}`;
+  if (defined(error) && defined(error.message)) {
+    message += `: ${error.message}`;
+  }
+
+  TileProviderError.reportError(
+    undefined,
+    provider,
+    defined(provider) ? provider._errorEvent : undefined,
+    message,
+    undefined,
+    undefined,
+    undefined,
+    error
+  );
+
+  throw new RuntimeError(message);
+}
+
+async function requestMetadata(
+  metadataResource,
+  imageryProviderBuilder,
+  provider
+) {
+  const cacheKey = metadataResource.url;
+  let promise = BingMapsImageryProvider._metadataCache[cacheKey];
+  if (!defined(promise)) {
+    promise = metadataResource.fetchJsonp("jsonp");
+    BingMapsImageryProvider._metadataCache[cacheKey] = promise;
+  }
+
+  try {
+    const data = await promise;
+    return metadataSuccess(data, imageryProviderBuilder);
+  } catch (e) {
+    metadataFailure(metadataResource, e, provider);
+  }
+}
+
+/**
+ * <div class="notice">
+ * To construct a BingMapsImageryProvider, call {@link BingMapsImageryProvider.fromUrl}. Do not call the constructor directly.
+ * </div>
+ *
  * Provides tiled imagery using the Bing Maps Imagery REST API.
  *
  * @alias BingMapsImageryProvider
@@ -44,6 +178,7 @@ import ImageryProvider from "./ImageryProvider.js";
  *
  * @param {BingMapsImageryProvider.ConstructorOptions} options Object describing initialization options
  *
+ * @see BingMapsImageryProvider.fromUrl
  * @see ArcGisMapServerImageryProvider
  * @see GoogleEarthEnterpriseMapsProvider
  * @see OpenStreetMapImageryProvider
@@ -53,12 +188,11 @@ import ImageryProvider from "./ImageryProvider.js";
  * @see WebMapTileServiceImageryProvider
  * @see UrlTemplateImageryProvider
  *
- *
  * @example
- * const bing = new Cesium.BingMapsImageryProvider({
- *     url : 'https://dev.virtualearth.net',
- *     key : 'get-yours-at-https://www.bingmapsportal.com/',
- *     mapStyle : Cesium.BingMapsStyle.AERIAL
+ * const bing = await Cesium.BingMapsImageryProvider.fromUrl(
+ *   "https://dev.virtualearth.net", {
+ *     key: "get-yours-at-https://www.bingmapsportal.com/",
+ *     mapStyle: Cesium.BingMapsStyle.AERIAL
  * });
  *
  * @see {@link http://msdn.microsoft.com/en-us/library/ff701713.aspx|Bing Maps REST Services}
@@ -66,109 +200,21 @@ import ImageryProvider from "./ImageryProvider.js";
  */
 function BingMapsImageryProvider(options) {
   options = defaultValue(options, defaultValue.EMPTY_OBJECT);
-  const accessKey = options.key;
 
-  //>>includeStart('debug', pragmas.debug);
-  if (!defined(options.url)) {
-    throw new DeveloperError("options.url is required.");
-  }
-  if (!defined(accessKey)) {
-    throw new DeveloperError("options.key is required.");
-  }
-  //>>includeEnd('debug');
+  this._defaultAlpha = undefined;
+  this._defaultNightAlpha = undefined;
+  this._defaultDayAlpha = undefined;
+  this._defaultBrightness = undefined;
+  this._defaultContrast = undefined;
+  this._defaultHue = undefined;
+  this._defaultSaturation = undefined;
+  this._defaultGamma = 1.0;
+  this._defaultMinificationFilter = undefined;
+  this._defaultMagnificationFilter = undefined;
 
-  /**
-   * 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 1.0
-   */
-  this.defaultGamma = 1.0;
-
-  /**
-   * 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._key = accessKey;
-  this._resource = Resource.createIfNeeded(options.url);
-  this._resource.appendForwardSlash();
-  this._tileProtocol = options.tileProtocol;
   this._mapStyle = defaultValue(options.mapStyle, BingMapsStyle.AERIAL);
   this._culture = defaultValue(options.culture, "");
+  this._key = options.key;
 
   this._tileDiscardPolicy = options.tileDiscardPolicy;
   if (!defined(this._tileDiscardPolicy)) {
@@ -191,123 +237,59 @@ function BingMapsImageryProvider(options) {
   this._maximumLevel = undefined;
   this._imageUrlTemplate = undefined;
   this._imageUrlSubdomains = undefined;
+  this._attributionList = undefined;
 
   this._errorEvent = new Event();
 
   this._ready = false;
+  if (defined(options.url)) {
+    deprecationWarning(
+      "BingMapsImageryProvider options.url",
+      "options.url was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use BingMapsImageryProvider.fromUrl instead."
+    );
 
-  let tileProtocol = this._tileProtocol;
-
-  // For backward compatibility reasons, the tileProtocol may end with
-  // a `:`. Remove it.
-  if (defined(tileProtocol)) {
-    if (
-      tileProtocol.length > 0 &&
-      tileProtocol[tileProtocol.length - 1] === ":"
-    ) {
-      tileProtocol = tileProtocol.substr(0, tileProtocol.length - 1);
-    }
-  } else {
-    // use http if the document's protocol is http, otherwise use https
-    const documentProtocol = document.location.protocol;
-    tileProtocol = documentProtocol === "http:" ? "http" : "https";
-  }
-
-  const metadataResource = this._resource.getDerivedResource({
-    url: `REST/v1/Imagery/Metadata/${this._mapStyle}`,
-    queryParameters: {
-      incl: "ImageryProviders",
-      key: this._key,
-      uriScheme: tileProtocol,
-    },
-  });
-  const that = this;
-  let metadataError;
-
-  function metadataSuccess(data) {
-    if (data.resourceSets.length !== 1) {
-      return metadataFailure();
-    }
-    const resource = data.resourceSets[0].resources[0];
-
-    that._tileWidth = resource.imageWidth;
-    that._tileHeight = resource.imageHeight;
-    that._maximumLevel = resource.zoomMax - 1;
-    that._imageUrlSubdomains = resource.imageUrlSubdomains;
-    that._imageUrlTemplate = resource.imageUrl;
-
-    let attributionList = (that._attributionList = resource.imageryProviders);
-    if (!attributionList) {
-      attributionList = that._attributionList = [];
-    }
-
-    for (
-      let attributionIndex = 0, attributionLength = attributionList.length;
-      attributionIndex < attributionLength;
-      ++attributionIndex
-    ) {
-      const attribution = attributionList[attributionIndex];
-
-      if (attribution.credit instanceof Credit) {
-        // If attribution.credit has already been created
-        // then we are using a cached value, which means
-        // none of the remaining processing needs to be done.
-        break;
-      }
+    //>>includeStart('debug', pragmas.debug);
+    Check.defined("options.key", options.key);
+    //>>includeEnd('debug');
 
-      attribution.credit = new Credit(attribution.attribution);
-      const coverageAreas = attribution.coverageAreas;
+    let tileProtocol = options.tileProtocol;
 
-      for (
-        let areaIndex = 0, areaLength = attribution.coverageAreas.length;
-        areaIndex < areaLength;
-        ++areaIndex
+    // For backward compatibility reasons, the tileProtocol may end with
+    // a `:`. Remove it.
+    if (defined(tileProtocol)) {
+      if (
+        tileProtocol.length > 0 &&
+        tileProtocol[tileProtocol.length - 1] === ":"
       ) {
-        const area = coverageAreas[areaIndex];
-        const bbox = area.bbox;
-        area.bbox = new Rectangle(
-          CesiumMath.toRadians(bbox[1]),
-          CesiumMath.toRadians(bbox[0]),
-          CesiumMath.toRadians(bbox[3]),
-          CesiumMath.toRadians(bbox[2])
-        );
+        tileProtocol = tileProtocol.substr(0, tileProtocol.length - 1);
       }
+    } else {
+      // use http if the document's protocol is http, otherwise use https
+      const documentProtocol = document.location.protocol;
+      tileProtocol = documentProtocol === "http:" ? "http" : "https";
     }
 
-    that._ready = true;
-    TileProviderError.reportSuccess(metadataError);
-    return Promise.resolve(true);
-  }
-
-  function metadataFailure(e) {
-    const message = `An error occurred while accessing ${metadataResource.url}.`;
-    metadataError = TileProviderError.reportError(
-      metadataError,
-      that,
-      that._errorEvent,
-      message,
-      undefined,
-      undefined,
-      undefined
-    );
-    if (metadataError.retry) {
-      return requestMetadata();
-    }
-    return Promise.reject(new RuntimeError(message));
-  }
-
-  const cacheKey = metadataResource.url;
-  function requestMetadata() {
-    const promise = metadataResource.fetchJsonp("jsonp");
-    BingMapsImageryProvider._metadataCache[cacheKey] = promise;
-    return promise.then(metadataSuccess).catch(metadataFailure);
-  }
+    const resource = Resource.createIfNeeded(options.url);
+    this._resource = resource;
+    resource.appendForwardSlash();
+    const metadataResource = resource.getDerivedResource({
+      url: `REST/v1/Imagery/Metadata/${this._mapStyle}`,
+      queryParameters: {
+        incl: "ImageryProviders",
+        key: options.key,
+        uriScheme: tileProtocol,
+      },
+    });
 
-  const promise = BingMapsImageryProvider._metadataCache[cacheKey];
-  if (defined(promise)) {
-    this._readyPromise = promise.then(metadataSuccess).catch(metadataFailure);
-  } else {
-    this._readyPromise = requestMetadata();
+    const imageryProviderBuilder = new ImageryProviderBuilder(options);
+    this._readyPromise = requestMetadata(
+      metadataResource,
+      imageryProviderBuilder,
+      this
+    ).then(() => {
+      imageryProviderBuilder.build(this);
+      return true;
+    });
   }
 }
 
@@ -315,7 +297,7 @@ Object.defineProperties(BingMapsImageryProvider.prototype, {
   /**
    * Gets the name of the BingMaps server url hosting the imagery.
    * @memberof BingMapsImageryProvider.prototype
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   url: {
@@ -339,7 +321,7 @@ Object.defineProperties(BingMapsImageryProvider.prototype, {
   /**
    * Gets the Bing Maps key.
    * @memberof BingMapsImageryProvider.prototype
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   key: {
@@ -365,7 +347,7 @@ Object.defineProperties(BingMapsImageryProvider.prototype, {
    * all cultures are supported. See {@link http://msdn.microsoft.com/en-us/library/hh441729.aspx}
    * for information on the supported cultures.
    * @memberof BingMapsImageryProvider.prototype
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   culture: {
@@ -375,127 +357,73 @@ Object.defineProperties(BingMapsImageryProvider.prototype, {
   },
 
   /**
-   * Gets the width of each tile, in pixels. This function should
-   * not be called before {@link BingMapsImageryProvider#ready} returns true.
+   * Gets the width of each tile, in pixels.
    * @memberof BingMapsImageryProvider.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._tileWidth;
     },
   },
 
   /**
-   * Gets the height of each tile, in pixels.  This function should
-   * not be called before {@link BingMapsImageryProvider#ready} returns true.
+   * Gets the height of each tile, in pixels.
    * @memberof BingMapsImageryProvider.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._tileHeight;
     },
   },
 
   /**
-   * Gets the maximum level-of-detail that can be requested.  This function should
-   * not be called before {@link BingMapsImageryProvider#ready} returns true.
+   * Gets the maximum level-of-detail that can be requested.
    * @memberof BingMapsImageryProvider.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._maximumLevel;
     },
   },
 
   /**
-   * Gets the minimum level-of-detail that can be requested.  This function should
-   * not be called before {@link BingMapsImageryProvider#ready} returns true.
+   * Gets the minimum level-of-detail that can be requested.
    * @memberof BingMapsImageryProvider.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 0;
     },
   },
 
   /**
-   * Gets the tiling scheme used by this provider.  This function should
-   * not be called before {@link BingMapsImageryProvider#ready} returns true.
+   * Gets the tiling scheme used by this provider.
    * @memberof BingMapsImageryProvider.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._tilingScheme;
     },
   },
 
   /**
-   * Gets the rectangle, in radians, of the imagery provided by this instance.  This function should
-   * not be called before {@link BingMapsImageryProvider#ready} returns true.
+   * Gets the rectangle, in radians, of the imagery provided by this instance.
    * @memberof BingMapsImageryProvider.prototype
    * @type {Rectangle}
    * @readonly
    */
   rectangle: {
     get: function () {
-      //>>includeStart('debug', pragmas.debug);
-      if (!this._ready) {
-        throw new DeveloperError(
-          "rectangle must not be called before the imagery provider is ready."
-        );
-      }
-      //>>includeEnd('debug');
-
       return this._tilingScheme.rectangle;
     },
   },
@@ -503,22 +431,13 @@ Object.defineProperties(BingMapsImageryProvider.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 BingMapsImageryProvider#ready} returns true.
+   * returns undefined, no tiles are filtered.
    * @memberof BingMapsImageryProvider.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._tileDiscardPolicy;
     },
   },
@@ -540,11 +459,16 @@ Object.defineProperties(BingMapsImageryProvider.prototype, {
   /**
    * Gets a value indicating whether or not the provider is ready for use.
    * @memberof BingMapsImageryProvider.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
+   * @deprecated
    */
   ready: {
     get: function () {
+      deprecationWarning(
+        "BingMapsImageryProvider.ready",
+        "BingMapsImageryProvider.ready was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use BingMapsImageryProvider.fromUrl instead."
+      );
       return this._ready;
     },
   },
@@ -552,18 +476,23 @@ Object.defineProperties(BingMapsImageryProvider.prototype, {
   /**
    * Gets a promise that resolves to true when the provider is ready for use.
    * @memberof BingMapsImageryProvider.prototype
-   * @type {Promise.<Boolean>}
+   * @type {Promise<boolean>}
    * @readonly
+   * @deprecated
    */
   readyPromise: {
     get: function () {
+      deprecationWarning(
+        "BingMapsImageryProvider.readyPromise",
+        "BingMapsImageryProvider.readyPromise was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use BingMapsImageryProvider.fromUrl instead."
+      );
       return this._readyPromise;
     },
   },
 
   /**
    * 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 BingMapsImageryProvider#ready} returns true.
+   * the source of the imagery.
    * @memberof BingMapsImageryProvider.prototype
    * @type {Credit}
    * @readonly
@@ -581,7 +510,7 @@ Object.defineProperties(BingMapsImageryProvider.prototype, {
    * as if their alpha is 1.0 everywhere.  Setting this property to false reduces memory usage
    * and texture upload time.
    * @memberof BingMapsImageryProvider.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   hasAlphaChannel: {
@@ -589,29 +518,317 @@ Object.defineProperties(BingMapsImageryProvider.prototype, {
       return false;
     },
   },
+
+  /**
+   * The default alpha blending value of this provider, with 0.0 representing fully transparent and
+   * 1.0 representing fully opaque.
+   * @memberof BingMapsImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultAlpha: {
+    get: function () {
+      deprecationWarning(
+        "BingMapsImageryProvider.defaultAlpha",
+        "BingMapsImageryProvider.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(
+        "BingMapsImageryProvider.defaultAlpha",
+        "BingMapsImageryProvider.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 BingMapsImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultNightAlpha: {
+    get: function () {
+      deprecationWarning(
+        "BingMapsImageryProvider.defaultNightAlpha",
+        "BingMapsImageryProvider.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(
+        "BingMapsImageryProvider.defaultNightAlpha",
+        "BingMapsImageryProvider.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 BingMapsImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultDayAlpha: {
+    get: function () {
+      deprecationWarning(
+        "BingMapsImageryProvider.defaultDayAlpha",
+        "BingMapsImageryProvider.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(
+        "BingMapsImageryProvider.defaultDayAlpha",
+        "BingMapsImageryProvider.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 BingMapsImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultBrightness: {
+    get: function () {
+      deprecationWarning(
+        "BingMapsImageryProvider.defaultBrightness",
+        "BingMapsImageryProvider.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(
+        "BingMapsImageryProvider.defaultBrightness",
+        "BingMapsImageryProvider.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 BingMapsImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultContrast: {
+    get: function () {
+      deprecationWarning(
+        "BingMapsImageryProvider.defaultContrast",
+        "BingMapsImageryProvider.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(
+        "BingMapsImageryProvider.defaultContrast",
+        "BingMapsImageryProvider.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 BingMapsImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultHue: {
+    get: function () {
+      deprecationWarning(
+        "BingMapsImageryProvider.defaultHue",
+        "BingMapsImageryProvider.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(
+        "BingMapsImageryProvider.defaultHue",
+        "BingMapsImageryProvider.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 BingMapsImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultSaturation: {
+    get: function () {
+      deprecationWarning(
+        "BingMapsImageryProvider.defaultSaturation",
+        "BingMapsImageryProvider.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(
+        "BingMapsImageryProvider.defaultSaturation",
+        "BingMapsImageryProvider.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 BingMapsImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultGamma: {
+    get: function () {
+      deprecationWarning(
+        "BingMapsImageryProvider.defaultGamma",
+        "BingMapsImageryProvider.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(
+        "BingMapsImageryProvider.defaultGamma",
+        "BingMapsImageryProvider.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 BingMapsImageryProvider.prototype
+   * @type {TextureMinificationFilter}
+   * @deprecated
+   */
+  defaultMinificationFilter: {
+    get: function () {
+      deprecationWarning(
+        "BingMapsImageryProvider.defaultMinificationFilter",
+        "BingMapsImageryProvider.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(
+        "BingMapsImageryProvider.defaultMinificationFilter",
+        "BingMapsImageryProvider.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 BingMapsImageryProvider.prototype
+   * @type {TextureMagnificationFilter}
+   * @deprecated
+   */
+  defaultMagnificationFilter: {
+    get: function () {
+      deprecationWarning(
+        "BingMapsImageryProvider.defaultMagnificationFilter",
+        "BingMapsImageryProvider.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(
+        "BingMapsImageryProvider.defaultMagnificationFilter",
+        "BingMapsImageryProvider.defaultMagnificationFilter was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.magnificationFilter instead."
+      );
+      this._defaultMagnificationFilter = value;
+    },
+  },
 });
 
+/**
+ * Creates an {@link ImageryProvider} which provides tiled imagery using the Bing Maps Imagery REST API.
+ *
+ * @param {Resource|String} url The url of the Bing Maps server hosting the imagery.
+ * @param {BingMapsImageryProvider.ConstructorOptions} options Object describing initialization options
+ * @returns {Promise<BingMapsImageryProvider>} A promise that resolves to the created BingMapsImageryProvider
+ *
+ * @example
+ * const bing = await Cesium.BingMapsImageryProvider.fromUrl(
+ *   "https://dev.virtualearth.net", {
+ *     key: "get-yours-at-https://www.bingmapsportal.com/",
+ *     mapStyle: Cesium.BingMapsStyle.AERIAL
+ * });
+ *
+ * @exception {RuntimeError} metadata does not specify one resource in resourceSets
+ */
+BingMapsImageryProvider.fromUrl = async function (url, options) {
+  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+
+  //>>includeStart('debug', pragmas.debug);
+  Check.defined("url", url);
+  Check.defined("options.key", options.key);
+  //>>includeEnd('debug');
+
+  let tileProtocol = options.tileProtocol;
+
+  // For backward compatibility reasons, the tileProtocol may end with
+  // a `:`. Remove it.
+  if (defined(tileProtocol)) {
+    if (
+      tileProtocol.length > 0 &&
+      tileProtocol[tileProtocol.length - 1] === ":"
+    ) {
+      tileProtocol = tileProtocol.substr(0, tileProtocol.length - 1);
+    }
+  } else {
+    // use http if the document's protocol is http, otherwise use https
+    const documentProtocol = document.location.protocol;
+    tileProtocol = documentProtocol === "http:" ? "http" : "https";
+  }
+
+  const mapStyle = defaultValue(options.mapStyle, BingMapsStyle.AERIAL);
+  const resource = Resource.createIfNeeded(url);
+  resource.appendForwardSlash();
+  const metadataResource = resource.getDerivedResource({
+    url: `REST/v1/Imagery/Metadata/${mapStyle}`,
+    queryParameters: {
+      incl: "ImageryProviders",
+      key: options.key,
+      uriScheme: tileProtocol,
+    },
+  });
+
+  const provider = new BingMapsImageryProvider(options);
+  provider._resource = resource;
+  const imageryProviderBuilder = new ImageryProviderBuilder(options);
+  await requestMetadata(metadataResource, imageryProviderBuilder);
+  imageryProviderBuilder.build(provider);
+  provider._readyPromise = Promise.resolve(true);
+  return provider;
+};
+
 const rectangleScratch = new Rectangle();
 
 /**
  * Gets the credits to be displayed when a given tile is displayed.
  *
- * @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;
  * @returns {Credit[]} The credits to be displayed when the tile is displayed.
- *
- * @exception {DeveloperError} <code>getTileCredits</code> must not be called before the imagery provider is ready.
  */
 BingMapsImageryProvider.prototype.getTileCredits = function (x, y, level) {
-  //>>includeStart('debug', pragmas.debug);
-  if (!this._ready) {
-    throw new DeveloperError(
-      "getTileCredits must not be called before the imagery provider is ready."
-    );
-  }
-  //>>includeEnd('debug');
-
   const rectangle = this._tilingScheme.tileXYToRectangle(
     x,
     y,
@@ -628,17 +845,14 @@ BingMapsImageryProvider.prototype.getTileCredits = function (x, y, level) {
 };
 
 /**
- * Requests the image for a given tile.  This function should
- * not be called before {@link BingMapsImageryProvider#ready} returns true.
+ * Requests the image for a given tile.
  *
- * @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.
  */
 BingMapsImageryProvider.prototype.requestImage = function (
   x,
@@ -646,14 +860,6 @@ BingMapsImageryProvider.prototype.requestImage = function (
   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');
-
   const promise = ImageryProvider.loadImage(
     this,
     buildImageResource(this, x, y, level, request)
@@ -678,11 +884,11 @@ BingMapsImageryProvider.prototype.requestImage = function (
  * Picking features is not currently supported by this imagery provider, so this function simply returns
  * undefined.
  *
- * @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.
+ * @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 {undefined} Undefined since picking is not supported.
  */
 BingMapsImageryProvider.prototype.pickFeatures = function (
@@ -699,9 +905,9 @@ BingMapsImageryProvider.prototype.pickFeatures = function (
  * Converts a tiles (x, y, level) position into a quadkey used to request an image
  * from a Bing Maps server.
  *
- * @param {Number} x The tile's x coordinate.
- * @param {Number} y The tile's y coordinate.
- * @param {Number} level The tile's zoom level.
+ * @param {number} x The tile's x coordinate.
+ * @param {number} y The tile's y coordinate.
+ * @param {number} level The tile's zoom level.
  *
  * @see {@link http://msdn.microsoft.com/en-us/library/bb259689.aspx|Bing Maps Tile System}
  * @see BingMapsImageryProvider#quadKeyToTileXY
@@ -729,7 +935,7 @@ BingMapsImageryProvider.tileXYToQuadKey = function (x, y, level) {
  * Converts a tile's quadkey used to request an image from a Bing Maps server into the
  * (x, y, level) position.
  *
- * @param {String} quadkey The tile's quad key
+ * @param {string} quadkey The tile's quad key
  *
  * @see {@link http://msdn.microsoft.com/en-us/library/bb259689.aspx|Bing Maps Tile System}
  * @see BingMapsImageryProvider#tileXYToQuadKey
@@ -763,7 +969,7 @@ Object.defineProperties(BingMapsImageryProvider, {
   /**
    * Gets or sets the URL to the Bing logo for display in the credit.
    * @memberof BingMapsImageryProvider
-   * @type {String}
+   * @type {string}
    */
   logoUrl: {
     get: function () {