Merge pull request #6903 from ykiu/bing-maps-culture

Add `culture` to `BingMapsCatalogItem`

CHANGES.md

@@ -2,6 +2,7 @@
 
 #### next release (8.5.1)
 
+- `BingMapsCatalogItem` now supports Bing's `culture` parameter.
 - Update a prompt text in DataPreview.
 - [The next improvement]
 

lib/Models/Catalog/CatalogItems/BingMapsCatalogItem.ts

@@ -28,7 +28,8 @@ export default class BingMapsCatalogItem extends MappableMixin(
       "//dev.virtualearth.net",
       {
         mapStyle: <any>this.mapStyle,
-        key: this.key!
+        key: this.key!,
+        culture: this.culture
       }
     );
     runInAction(() => {

lib/Traits/TraitsClasses/BingMapsCatalogItemTraits.ts

@@ -27,4 +27,11 @@ export default class BingMapsCatalogItemTraits extends mixTraits(
     description: "The Bing Maps key"
   })
   key?: string;
+
+  @primitiveTrait({
+    type: "string",
+    name: "Culture",
+    description: "The Bing Maps culture code"
+  })
+  culture?: string;
 }

test/Models/Catalog/CatalogItems/BingMapsCatalogItemSpec.ts

@@ -0,0 +1,129 @@
+import { runInAction } from "mobx";
+import Rectangle from "terriajs-cesium/Source/Core/Rectangle";
+import Resource from "terriajs-cesium/Source/Core/Resource";
+import BingMapsImageryProvider from "terriajs-cesium/Source/Scene/BingMapsImageryProvider";
+import BingMapsStyle from "terriajs-cesium/Source/Scene/BingMapsStyle";
+import { ImageryParts } from "../../../../lib/ModelMixins/MappableMixin";
+import BingMapsCatalogItem from "../../../../lib/Models/Catalog/CatalogItems/BingMapsCatalogItem";
+import Terria from "../../../../lib/Models/Terria";
+
+describe("BingMapsCatalogItem", () => {
+  let item: BingMapsCatalogItem;
+
+  beforeEach(async () => {
+    spyOn(Resource.prototype, "fetchJsonp").and.returnValue(
+      Promise.resolve({
+        // A clipped version of an actual request to
+        // http://dev.virtualearth.net/REST/v1/Imagery/Metadata/Aerial
+        resourceSets: [
+          {
+            estimatedTotal: 1,
+            resources: [
+              {
+                __type:
+                  "ImageryMetadata:http://schemas.microsoft.com/search/local/ws/rest/v1",
+                imageHeight: 256,
+                imageUrl:
+                  "https://ecn.{subdomain}.tiles.virtualearth.net/tiles/a{quadkey}.jpeg",
+                imageUrlSubdomains: ["t0", "t1", "t2", "t3"],
+                imageWidth: 256,
+                imageryProviders: [],
+                vintageEnd: null,
+                vintageStart: null,
+                zoomMax: 21,
+                zoomMin: 1
+              }
+            ]
+          }
+        ]
+      })
+    );
+    item = new BingMapsCatalogItem("test", new Terria());
+    runInAction(() => item.setTrait("definition", "key", "XXXXX"));
+
+    await item.loadMapItems();
+  });
+
+  it("has a type", () => {
+    expect(BingMapsCatalogItem.type).toBe("bing-maps");
+  });
+
+  describe("the mapItem", () => {
+    it("correctly sets the `alpha` value", () => {
+      if (!ImageryParts.is(item.mapItems[0]))
+        throw new Error("Expected MapItem to be an ImageryParts");
+
+      runInAction(() => item.setTrait("definition", "opacity", 0.42));
+      expect(item.mapItems[0].alpha).toBe(0.42);
+    });
+
+    it("correctly sets `show`", () => {
+      if (!ImageryParts.is(item.mapItems[0]))
+        throw new Error("Expected MapItem to be an ImageryParts");
+
+      runInAction(() => item.setTrait("definition", "show", false));
+      expect(item.mapItems[0].show).toBe(false);
+      runInAction(() => item.setTrait("definition", "show", true));
+      expect(item.mapItems[0].show).toBe(true);
+    });
+
+    it("correctly sets `clippingRectangle`", function () {
+      const rectangleDegrees = { west: 10, south: -15, east: 20, north: 20 };
+      item.setTrait("definition", "rectangle", rectangleDegrees);
+      if (!ImageryParts.is(item.mapItems[0]))
+        throw new Error("Expected MapItem to be an ImageryParts");
+      if (item.mapItems[0].clippingRectangle === undefined) {
+        throw new Error("Expected clippingRectangle to be defined.");
+      }
+
+      const rectangleRadians = Rectangle.fromDegrees(
+        rectangleDegrees.west,
+        rectangleDegrees.south,
+        rectangleDegrees.east,
+        rectangleDegrees.north
+      );
+
+      expect(item.mapItems[0].clippingRectangle.west).toBeCloseTo(
+        rectangleRadians.west
+      );
+      expect(item.mapItems[0].clippingRectangle.south).toBeCloseTo(
+        rectangleRadians.south
+      );
+      expect(item.mapItems[0].clippingRectangle.east).toBeCloseTo(
+        rectangleRadians.east
+      );
+      expect(item.mapItems[0].clippingRectangle.north).toBeCloseTo(
+        rectangleRadians.north
+      );
+    });
+  });
+
+  describe("imageryProvider", () => {
+    it("has the correct properties", async () => {
+      runInAction(() => {
+        item.setTrait("definition", "mapStyle", BingMapsStyle.AERIAL);
+        item.setTrait("definition", "culture", "fr");
+      });
+
+      await item.loadMapItems();
+
+      if (!ImageryParts.is(item.mapItems[0]))
+        throw new Error("Expected MapItem to be an ImageryParts");
+      const imageryProvider = item.mapItems[0].imageryProvider;
+      if (!(imageryProvider instanceof BingMapsImageryProvider))
+        throw new Error(
+          "Expected imageryProvider to be a BingMapsImageryProvider"
+        );
+
+      expect({
+        mapStyle: imageryProvider.mapStyle,
+        key: imageryProvider.key,
+        culture: imageryProvider.culture
+      }).toEqual({
+        mapStyle: BingMapsStyle.AERIAL,
+        key: "XXXXX",
+        culture: "fr"
+      });
+    });
+  });
+});