Display draw status

View on GitHub
Sample viewer app

Get the draw status of your map view or scene view to know when all layers in the map or scene have finished drawing.

Image of display drawing status

Use case

You may want to display a loading indicator while layers are loading, which could then be removed on DrawStatus.COMPLETED.

How to use the sample

Pan and zoom around the map. Observe how the status bar changes from a loading animation to solid, indicating that drawing has completed.

How it works

  1. Create a MapView and add a DrawStatusChangedListener to it.
  2. Use getDrawStatus on the DrawStatusChangedEvent to determine draw status.

Relevant API

  • ArcGISMap
  • DrawStatus
  • DrawStatusChangedEvent
  • DrawStatusChangedListener
  • MapView

Tags

draw, loading, map, render

Sample Code

DisplayDrawingStatusSample.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
/*
 * 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.display_drawing_status;

import javafx.application.Application;
import javafx.geometry.Insets;
import javafx.geometry.Pos;
import javafx.scene.Scene;
import javafx.scene.control.ProgressBar;
import javafx.scene.layout.StackPane;
import javafx.stage.Stage;

import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
import com.esri.arcgisruntime.data.ServiceFeatureTable;
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.layers.FeatureLayer;
import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.BasemapStyle;
import com.esri.arcgisruntime.mapping.Viewpoint;
import com.esri.arcgisruntime.mapping.view.DrawStatus;
import com.esri.arcgisruntime.mapping.view.MapView;

public class DisplayDrawingStatusSample extends Application {

  private MapView mapView;

  @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("Display Drawing Status 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 progress bar
      ProgressBar progressBar = new ProgressBar();
      progressBar.setMaxWidth(240.0);

      // create a map with the topographic basemap style
      final ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);

      // create a feature table from a service URL
      final ServiceFeatureTable featureTable = new ServiceFeatureTable(
          "https://sampleserver6.arcgisonline.com/arcgis/rest/services/DamageAssessment/FeatureServer/0");

      // create a feature layer from service table
      final FeatureLayer featureLayer = new FeatureLayer(featureTable);

      // add the feature layer to the map's operational layers
      map.getOperationalLayers().add(featureLayer);

      // create a map view and set the map to it
      mapView = new MapView();
      mapView.setMap(map);

      // create a viewpoint and set it to the map view
      Point bottomLeftPoint = new Point(-1.5054808160556655E7, 2718975.702666207, SpatialReferences.getWebMercator());
      Point topRightPoint = new Point(-6810317.90634398, 6850505.377826911, SpatialReferences.getWebMercator());
      Envelope envelope = new Envelope(bottomLeftPoint, topRightPoint);
      mapView.setViewpoint(new Viewpoint(envelope));

      mapView.addDrawStatusChangedListener(e -> {
        // check to see if draw status is in progress
        if (e.getDrawStatus() == DrawStatus.IN_PROGRESS) {
          // reset progress bar as in progress
          progressBar.setProgress(-100.0);

          // check to see if draw status is complete
        } else if (e.getDrawStatus() == DrawStatus.COMPLETED) {
          // set progress bar as complete
          progressBar.setProgress(100.0);
        }
      });

      // add the map view and progress bar to stack pane
      stackPane.getChildren().addAll(mapView, progressBar);
      StackPane.setAlignment(progressBar, Pos.TOP_LEFT);
      StackPane.setMargin(progressBar, 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.