New Basemaps: Map Category - part 1 of 2 (#604)

* Update build.gradle

* display map

* Access load status

* Change basemap

* Create and save map

* Update readme metadata files

* Change basemap - set viewpoint on mapview

* Access load status - amend comment

* Change Basemap - variable naming

* Create and save map - code review tidy ups

* update build.gradle - versions

* tidy comment and scale consistencies

Author: jenmerritt

map/access-load-status/build.gradle

@@ -6,7 +6,7 @@ plugins {
 group = 'com.esri.samples'
 
 ext {
-    arcgisVersion = '100.9.0'
+    arcgisVersion = '100.10.0-2992'
 }
 
 javafx {

map/access-load-status/src/main/java/com/esri/samples/access_load_status/AccessLoadStatusSample.java

@@ -32,8 +32,9 @@
 import javafx.scene.paint.Paint;
 import javafx.stage.Stage;
 
+import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
 import com.esri.arcgisruntime.mapping.ArcGISMap;
-import com.esri.arcgisruntime.mapping.Basemap;
+import com.esri.arcgisruntime.mapping.BasemapStyle;
 import com.esri.arcgisruntime.mapping.view.MapView;
 
 public class AccessLoadStatusSample extends Application {
@@ -57,6 +58,10 @@ public void start(Stage stage) {
       stage.setScene(scene);
       stage.show();
 
+      // authentication with an API key or named user is required to access basemaps and other location services
+      String yourAPIKey = System.getProperty("apiKey");
+      ArcGISRuntimeEnvironment.setApiKey(yourAPIKey);
+
       // create a control panel
       VBox controlsVBox = new VBox(6);
       controlsVBox.setBackground(new Background(new BackgroundFill(Paint.valueOf("rgba(0,0,0,0.3)"), CornerRadii.EMPTY,
@@ -74,12 +79,12 @@ public void start(Stage stage) {
       Button reloadMapButton = new Button("Reload ArcGISMap");
       reloadMapButton.setMaxWidth(Double.MAX_VALUE);
 
-      // reload ArcGISMap when button clicked
+      // reload the map when the button is clicked
       reloadMapButton.setOnAction(event -> {
         loadStatusText.clear();
 
-        // reload the same ArcGISMap
-        map = new ArcGISMap(Basemap.createImagery());
+        // reload the map
+        map = new ArcGISMap(BasemapStyle.ARCGIS_IMAGERY_STANDARD);
 
         map.addLoadStatusChangedListener(e -> {
           String loadingStatus;
@@ -112,10 +117,10 @@ public void start(Stage stage) {
       // add label, text and button to the control panel
       controlsVBox.getChildren().addAll(loadStatusLabel, loadStatusText, reloadMapButton);
 
-      // create ArcGISMap with the imagery basemap
-      map = new ArcGISMap(Basemap.createImagery());
+      // create a map with the standard imagery basemap style
+      map = new ArcGISMap(BasemapStyle.ARCGIS_IMAGERY_STANDARD);
 
-      // create a view for this ArcGISMap and set ArcGISMap to it
+      // create a map view and set the map to it
       mapView = new MapView();
       mapView.setMap(map);
 

map/change-basemap/README.md

@@ -6,21 +6,21 @@ Change a map's basemap. A basemap is beneath all layers on an `ArcGISMap` and is
 
 ## Use case
 
-Basemaps should selected contextually, for example, in maritime applications, it would be more appropriate to use a basemap of the world's oceans as opposed to a basemap of the world's streets.
+Basemaps should be selected contextually, for example, in maritime applications, it would be more appropriate to use a basemap of the world's oceans as opposed to a basemap of the world's streets.
 
 ## How to use the sample
 
-Select a basemap from the list of available basemaps to set it to the map.
+Select a basemap style from the list to set it to the map.
 
 ## How it works
 
 1. Create an `ArcGISMap` object.
 2. Set the map to the `MapView` object.
-3. Choose a new basemap type with `Basemap.Type` and set it on the map.
+3. Choose a new basemap style with `BasemapStyle` and set it on the map.
 
 ## Relevant API
 * ArcGISMap
-* Basemap
+* BasemapStyle
 * MapView
 
 ## Tags

map/change-basemap/README.metadata.json

@@ -9,15 +9,15 @@
         "basemap",
         "map",
         "ArcGISMap",
-        "Basemap",
+        "BasemapStyle",
         "MapView"
     ],
     "redirect_from": [
         "/java/latest/sample-code/change-basemap.htm"
     ],
     "relevant_apis": [
         "ArcGISMap",
-        "Basemap",
+        "BasemapStyle",
         "MapView"
     ],
     "snippets": [

map/change-basemap/build.gradle

@@ -6,7 +6,7 @@ plugins {
 group = 'com.esri.samples'
 
 ext {
-    arcgisVersion = '100.9.0'
+    arcgisVersion = '100.10.0-2992'
 }
 
 javafx {

map/change-basemap/src/main/java/com/esri/samples/change_basemap/ChangeBasemapSample.java

@@ -25,19 +25,17 @@
 import javafx.scene.layout.StackPane;
 import javafx.stage.Stage;
 
+import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
 import com.esri.arcgisruntime.mapping.ArcGISMap;
-import com.esri.arcgisruntime.mapping.Basemap;
+import com.esri.arcgisruntime.mapping.BasemapStyle;
+import com.esri.arcgisruntime.mapping.Viewpoint;
 import com.esri.arcgisruntime.mapping.view.MapView;
 
 public class ChangeBasemapSample extends Application {
 
   private MapView mapView;
   private ArcGISMap map;
 
-  private static final double LATITUDE = 57.5000;
-  private static final double LONGITUDE = -5.0000;
-  private static final int LOD = 6;
-
   @Override
   public void start(Stage stage) {
 
@@ -53,27 +51,32 @@ public void start(Stage stage) {
       stage.setScene(scene);
       stage.show();
 
+      // authentication with an API key or named user is required to access basemaps and other location services
+      String yourAPIKey = System.getProperty("apiKey");
+      ArcGISRuntimeEnvironment.setApiKey(yourAPIKey);
+
       // creates a map view
       mapView = new MapView();
 
-      // setup listview of basemaps
-      ListView<Basemap.Type> basemapList = new ListView<>(FXCollections.observableArrayList(Basemap.Type.values()));
-      basemapList.setMaxSize(250, 150);
+      // setup a list view of basemap styles
+      ListView<BasemapStyle> basemapStyleListView = new ListView<>(FXCollections.observableArrayList(BasemapStyle.values()));
+      basemapStyleListView.setMaxSize(250, 150);
 
-      // change the basemap when list option is selected
-      basemapList.getSelectionModel().selectedItemProperty().addListener(o -> {
-        String basemapString = basemapList.getSelectionModel().getSelectedItem().toString();
-        map = new ArcGISMap(Basemap.Type.valueOf(basemapString), LATITUDE, LONGITUDE, LOD);
+      // change the basemap when a list option is selected
+      basemapStyleListView.getSelectionModel().selectedItemProperty().addListener(o -> {
+        BasemapStyle selectedBasemapStyle = basemapStyleListView.getSelectionModel().getSelectedItem();
+        map = new ArcGISMap(selectedBasemapStyle);
         mapView.setMap(map);
+        mapView.setViewpoint(new Viewpoint(57.5000, -5.0000, 9244648));
       });
 
-      // select the first basemap
-      basemapList.getSelectionModel().selectFirst();
+      // select the first basemap style
+      basemapStyleListView.getSelectionModel().selectFirst();
 
       // add the map view and control panel to stack pane
-      stackPane.getChildren().addAll(mapView, basemapList);
-      StackPane.setAlignment(basemapList, Pos.TOP_LEFT);
-      StackPane.setMargin(basemapList, new Insets(10, 0, 0, 10));
+      stackPane.getChildren().addAll(mapView, basemapStyleListView);
+      StackPane.setAlignment(basemapStyleListView, Pos.TOP_LEFT);
+      StackPane.setMargin(basemapStyleListView, new Insets(10, 0, 0, 10));
 
     } catch (Exception e) {
       // on any error, display the stack trace.

map/create-and-save-map/build.gradle

@@ -6,7 +6,7 @@ plugins {
 group = 'com.esri.samples'
 
 ext {
-    arcgisVersion = '100.9.0'
+    arcgisVersion = '100.10.0-2992'
 }
 
 javafx {

map/create-and-save-map/src/main/java/com/esri/samples/create_and_save_map/CreateAndSaveMapController.java

@@ -32,12 +32,14 @@
 import javafx.scene.control.TextField;
 import javafx.util.StringConverter;
 
+import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
 import com.esri.arcgisruntime.concurrent.ListenableFuture;
 import com.esri.arcgisruntime.layers.ArcGISMapImageLayer;
 import com.esri.arcgisruntime.layers.Layer;
 import com.esri.arcgisruntime.loadable.LoadStatus;
 import com.esri.arcgisruntime.mapping.ArcGISMap;
 import com.esri.arcgisruntime.mapping.Basemap;
+import com.esri.arcgisruntime.mapping.BasemapStyle;
 import com.esri.arcgisruntime.mapping.view.MapView;
 import com.esri.arcgisruntime.portal.Portal;
 import com.esri.arcgisruntime.portal.PortalFolder;
@@ -60,7 +62,7 @@ public class CreateAndSaveMapController {
   @FXML
   private ComboBox<PortalFolder> folderList;
   @FXML
-  private ListView<Basemap> basemapList;
+  private ListView<BasemapStyle> basemapStyleListView;
   @FXML
   private ListView<Layer> layersList;
   @FXML
@@ -74,29 +76,36 @@ public class CreateAndSaveMapController {
   @FXML
   private void initialize() {
 
-    // set basemap options
-    basemapList.getItems().addAll(Basemap.createStreets(), Basemap.createImagery(), Basemap
-            .createTopographic(), Basemap.createOceans());
+    // authentication with an API key or named user is required to access basemaps and other location services
+    String yourAPIKey = System.getProperty("apiKey");
+    ArcGISRuntimeEnvironment.setApiKey(yourAPIKey);
 
-    // update basemap when selection changes
-    basemapList.getSelectionModel().select(0);
-    basemapList.getSelectionModel().selectedItemProperty()
-            .addListener(o -> map.setBasemap(basemapList.getSelectionModel().getSelectedItem()));
+    // set the basemap style options
+    basemapStyleListView.getItems().addAll(
+      BasemapStyle.ARCGIS_STREETS,
+      BasemapStyle.ARCGIS_IMAGERY_STANDARD,
+      BasemapStyle.ARCGIS_TOPOGRAPHIC,
+      BasemapStyle.ARCGIS_OCEANS);
 
-    basemapList.setCellFactory(c -> new BasemapCell());
+    basemapStyleListView.setCellFactory(c -> new BasemapCell());
 
-    // create and set a map with the first basemap option
-    map = new ArcGISMap(basemapList.getSelectionModel().getSelectedItem());
+    // update the basemap when the selection changes
+    basemapStyleListView.getSelectionModel().select(0);
+    basemapStyleListView.getSelectionModel().selectedItemProperty()
+      .addListener(o -> map.setBasemap(new Basemap(basemapStyleListView.getSelectionModel().getSelectedItem())));
+
+    // create a basemap with the first basemap style option and set it to the map
+    Basemap basemap = new Basemap(basemapStyleListView.getSelectionModel().getSelectedItem());
+    map = new ArcGISMap(basemap);
     mapView.setMap(map);
 
     // set operational layer options
-    String worldElevationService =
-            "https://sampleserver6.arcgisonline.com/arcgis/rest/services/WorldTimeZones/MapServer";
-    ArcGISMapImageLayer worldElevation = new ArcGISMapImageLayer(worldElevationService);
+    ArcGISMapImageLayer worldElevation = new ArcGISMapImageLayer(
+      "https://sampleserver6.arcgisonline.com/arcgis/rest/services/WorldTimeZones/MapServer");
     worldElevation.loadAsync();
 
-    String worldCensusService = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer";
-    ArcGISMapImageLayer worldCensus = new ArcGISMapImageLayer(worldCensusService);
+    ArcGISMapImageLayer worldCensus = new ArcGISMapImageLayer(
+      "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer");
     worldCensus.loadAsync();
 
     layersList.getItems().addAll(worldElevation, worldCensus);
@@ -171,14 +180,14 @@ void authenticate() {
   }
 
   /**
-   * Shows a Basemap title in a ListView.
+   * Shows a BasemapStyle title in a ListView.
    */
-  private class BasemapCell extends ListCell<Basemap> {
+  private class BasemapCell extends ListCell<BasemapStyle> {
 
     @Override
-    protected void updateItem(Basemap basemap, boolean empty) {
-      super.updateItem(basemap, empty);
-      setText(empty || basemap == null ? null : basemap.getName());
+    protected void updateItem(BasemapStyle basemapStyle, boolean empty) {
+      super.updateItem(basemapStyle, empty);
+      setText(empty || basemapStyle == null ? null : basemapStyle.name());
       setGraphic(null);
     }
   }
@@ -204,7 +213,7 @@ private void saveMap() {
     progress.setVisible(true);
     try {
       ListenableFuture<PortalItem> result = map.saveAsAsync(portal, folderList.getSelectionModel().getSelectedItem(),
-              title.getText(), Arrays.asList(tags.getText().split(",")), description.getText(), null, true);
+        title.getText(), Arrays.asList(tags.getText().split(",")), description.getText(), null, true);
       result.addDoneListener(() -> {
         try {
           PortalItem portalItem = result.get();

map/create-and-save-map/src/main/resources/create_and_save_map/main.fxml

@@ -66,7 +66,7 @@
         </VBox>
         <VBox>
             <Label text="Basemap"/>
-            <ListView fx:id="basemapList"/>
+            <ListView fx:id="basemapStyleListView"/>
         </VBox>
         <VBox>
             <Label text="Operational layers"/>

map/display-map/README.md

@@ -14,14 +14,14 @@ Run the sample to view the map. Pan and zoom to navigate the map.
 
 ## How it works
 
-1. Create an ArcGIS map using a default `Basemap` such use `Basemap.createImagery()`.
+1. Create an ArcGIS map using a default `BasemapStyle` such as `BasemapStyle.ARCGIS_IMAGERY_STANDARD`.
 2. Create a `MapView` object to display the map.
 3. Set the map to the map view.
 
 ## Relevant API
 
 * ArcGISMap
-* Basemap
+* BasemapStyle
 * MapView
 
 ## Tags