Change basemap

View on GitHub
Sample viewer app

Change a map's basemap. A basemap is beneath all layers on an ArcGISMap and is used to provide visual reference for the operational layers.

Image of change basemap

Use case

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 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 style with BasemapStyle and set it on the map.

Relevant API

  • ArcGISMap
  • BasemapStyle
  • MapView

Tags

basemap, map

Sample Code

ChangeBasemapSample.java
                                                                                                                 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/*
 * Copyright 2017 Esri.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.esri.samples.change_basemap;

import javafx.application.Application;
import javafx.collections.FXCollections;
import javafx.geometry.Insets;
import javafx.geometry.Pos;
import javafx.scene.Scene;
import javafx.scene.control.ListView;
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;

  @Override
  public void start(Stage stage) {

    try {
      // create stack pane and application scene
      StackPane stackPane = new StackPane();
      Scene scene = new Scene(stackPane);

      // set title, size, and add scene to stage
      stage.setTitle("Change Basemap Sample");
      stage.setWidth(800);
      stage.setHeight(700);
      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 map view
      mapView = new MapView();
      // create a new map and set it to the map view: a basemap style will be added to the map once the sample loads
      map = new ArcGISMap();
      mapView.setMap(map);
      // create a new view point centered on Scotland, UK
      mapView.setViewpoint(new Viewpoint(57.5000, -5.0000, 9244648));

      // setup a list view of basemap styles
      ListView<BasemapStyle> basemapStyleListView = new ListView<>(FXCollections.observableArrayList(BasemapStyle.values()));
      basemapStyleListView.setMaxSize(250, 150);

      // change the basemap when a list option is selected
      basemapStyleListView.getSelectionModel().selectedItemProperty().addListener(o -> {
        BasemapStyle selectedBasemapStyle = basemapStyleListView.getSelectionModel().getSelectedItem();
        Basemap basemap = new Basemap(selectedBasemapStyle);
        map.setBasemap(basemap);
      });

      // select the first basemap style
      basemapStyleListView.getSelectionModel().selectFirst();

      // add the map view and control panel to stack pane
      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.
      e.printStackTrace();
    }
  }

  /**
   * Stops and releases all resources used in application.
   */
  @Override
  public void stop() {

    if (mapView != null) {
      mapView.dispose();
    }
  }

  /**
   * Opens and runs application.
   *
   * @param args arguments passed to this application
   */
  public static void main(String[] args) {

    Application.launch(args);
  }

}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.