Map rotation

View on GitHub
Sample viewer app

Rotate a map.

Image of map rotation

Use case

A user may wish to view the map in an orientation other than north-facing.

How to use the sample

Use the slider to rotate the map. If the map is not pointed north, the compass will display the current heading. Click the compass to set the map's heading to north.

How it works

  1. Create a ArcGISMap and set it to a MapView.
  2. Use setViewpointRotationAsync(...) to set the rotation angle of the map.

Relevant API

  • ArcGISMap
  • MapView

Tags

compass, rotate, rotation, viewpoint

Sample Code

MapRotationSample.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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/*
 * Copyright 2018 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.map_rotation;

import javafx.application.Application;
import javafx.geometry.Insets;
import javafx.geometry.Pos;
import javafx.scene.Scene;
import javafx.scene.control.Alert;
import javafx.scene.control.Slider;
import javafx.scene.layout.Background;
import javafx.scene.layout.BackgroundFill;
import javafx.scene.layout.CornerRadii;
import javafx.scene.layout.StackPane;
import javafx.scene.paint.Paint;
import javafx.stage.Stage;

import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
import com.esri.arcgisruntime.geometry.Envelope;
import com.esri.arcgisruntime.geometry.Point;
import com.esri.arcgisruntime.geometry.SpatialReference;
import com.esri.arcgisruntime.geometry.SpatialReferences;
import com.esri.arcgisruntime.loadable.LoadStatus;
import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.BasemapStyle;
import com.esri.arcgisruntime.mapping.Viewpoint;
import com.esri.arcgisruntime.mapping.view.MapView;
import com.esri.arcgisruntime.toolkit.Compass;

public class MapRotationSample extends Application {

  private ArcGISMap map; // keep loadable in scope to avoid garbage collection
  private MapView mapView;
  private Slider slider;

  @Override
  public void start(Stage stage) {

    try {
      // create stack pane and application scene
      StackPane stackPane = new StackPane();
      Scene scene = new Scene(stackPane);
      scene.getStylesheets().add(getClass().getResource("/map_rotation/style.css").toExternalForm());

      // set title, size, and add scene to stage
      stage.setTitle("Map Rotation 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 slider with a range of 360 units and set it to 5 degrees
      slider = new Slider(-180.0, 180.0, 5.0);
      styleSlider();

      // listen for the value in the slider to change
      slider.valueProperty().addListener(e -> {
        // rotate map view based on new value in slider
        mapView.setViewpointRotationAsync(slider.getValue());
      });

      // create a map with the streets basemap style
      map = new ArcGISMap(BasemapStyle.ARCGIS_STREETS);

      // enable slider when map view is done loading
      map.addDoneLoadingListener(() -> {
        if (map.getLoadStatus() == LoadStatus.LOADED) {
          slider.setDisable(false);
        } else {
          Alert alert = new Alert(Alert.AlertType.ERROR, "Map Failed to Load!");
          alert.show();
        }
      });

      // create a map view and set the map to it
      mapView = new MapView();
      // disable keyboard navigation to focus on slider/compass map rotation interaction
      mapView.setEnableKeyboardNavigation(false);
      mapView.setMap(map);

      // create a compass to show the current heading when rotated
      Compass compass = new Compass(mapView);

      // clicking the compass sets the map's heading to 0.0 (north) and the compass is hidden
      // add a listener to reset the slider when this happens
      compass.setOnMouseClicked(e -> slider.setValue(0.0));

      // create a starting viewpoint for the map view
      SpatialReference spatialReference = SpatialReferences.getWebMercator();
      Point pointBottomLeft = new Point(-13639984.0, 4537387.0, spatialReference);
      Point pointTopRight = new Point(-13606734.0, 4558866, spatialReference);
      Envelope envelope = new Envelope(pointBottomLeft, pointTopRight);
      // set the viewpoint with a rotation of 5 degrees (so that the sample loads with the compass visible)
      Viewpoint viewpoint = new Viewpoint(envelope, 5.0f);

      // set viewpoint to the map view
      mapView.setViewpointAsync(viewpoint);

      // add the map view, slider, and compass to the stack pane
      stackPane.getChildren().addAll(mapView, slider, compass);
      StackPane.setAlignment(slider, Pos.TOP_LEFT);
      StackPane.setAlignment(compass, Pos.TOP_RIGHT);
      StackPane.setMargin(slider, new Insets(50, 0, 0, 10));
      StackPane.setMargin(compass, new Insets(10, 10, 0, 0));
    } catch (Exception e) {
      // on any error, display the stack trace
      e.printStackTrace();
    }
  }

  /**
   * Styles the slider component for enhanced visibility on the map view.
   */
  private void styleSlider() {

    slider.setMaxWidth(240.0);
    slider.setMajorTickUnit(90);
    slider.setShowTickLabels(true);
    slider.setShowTickMarks(true);
    slider.setDisable(true);
    slider.setStyle("-fx-font-weight: bold; -fx-font-size: 15;");
    slider.setPadding(new Insets(10, 10, 0, 10));
    slider.setBackground(new Background(new BackgroundFill(Paint.valueOf("rgba(0,0,0,0.3)"), CornerRadii.EMPTY, Insets.EMPTY)));

  }

  /**
   * 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.