Skip To Content ArcGIS for Developers Sign In Dashboard

Viewshed Geoprocessing


 * 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
 * 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.analysis.viewshed_geoprocessing;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.ExecutionException;

import javafx.application.Application;
import javafx.geometry.Point2D;
import javafx.geometry.Pos;
import javafx.scene.Scene;
import javafx.scene.control.Alert;
import javafx.scene.control.Alert.AlertType;
import javafx.scene.control.ProgressIndicator;
import javafx.scene.input.MouseButton;
import javafx.scene.layout.StackPane;
import javafx.scene.paint.Color;
import javafx.stage.Stage;

import com.esri.arcgisruntime.concurrent.Job;
import com.esri.arcgisruntime.concurrent.ListenableFuture;
import com.esri.arcgisruntime.geometry.GeometryType;
import com.esri.arcgisruntime.geometry.Point;
import com.esri.arcgisruntime.loadable.LoadStatus;
import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.Basemap;
import com.esri.arcgisruntime.mapping.view.Graphic;
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
import com.esri.arcgisruntime.mapping.view.MapView;
import com.esri.arcgisruntime.symbology.ColorUtil;
import com.esri.arcgisruntime.symbology.FillSymbol;
import com.esri.arcgisruntime.symbology.SimpleFillSymbol;
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
import com.esri.arcgisruntime.symbology.SimpleRenderer;
import com.esri.arcgisruntime.tasks.geoprocessing.GeoprocessingFeatures;
import com.esri.arcgisruntime.tasks.geoprocessing.GeoprocessingJob;
import com.esri.arcgisruntime.tasks.geoprocessing.GeoprocessingParameters;
import com.esri.arcgisruntime.tasks.geoprocessing.GeoprocessingResult;
import com.esri.arcgisruntime.tasks.geoprocessing.GeoprocessingTask;

public class ViewshedGeoprocessingSample extends Application {

  private MapView mapView;
  private GeoprocessingJob geoprocessingJob;

  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("Viewshed Geoprocessing Sample");

      // create a view with a map and topographic basemap
      ArcGISMap map = new ArcGISMap(Basemap.Type.TOPOGRAPHIC, 45.3790902612337, 6.84905317262762, 12);
      mapView = new MapView();

      // create an input graphics overlay to show red point markers where the user clicks
      SimpleMarkerSymbol pointSymbol = new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.CIRCLE, 0xFFFF0000, 10);
      SimpleRenderer renderer = new SimpleRenderer(pointSymbol);
      GraphicsOverlay inputGraphicsOverlay = new GraphicsOverlay();

      // create an output graphics overlay to show the viewsheds as orange areas
      int fillColor = ColorUtil.colorToArgb(Color.rgb(226, 119, 40, 0.5));
      FillSymbol fillSymbol = new SimpleFillSymbol(SimpleFillSymbol.Style.SOLID, fillColor, null);
      GraphicsOverlay outputGraphicsOverlay = new GraphicsOverlay();
      outputGraphicsOverlay.setRenderer(new SimpleRenderer(fillSymbol));

      // add the graphics overlays to the map view
      mapView.getGraphicsOverlays().addAll(Arrays.asList(inputGraphicsOverlay, outputGraphicsOverlay));

      // show progress indicator when geoprocessing task is loading or geoprocessing job is running
      ProgressIndicator progress = new ProgressIndicator(ProgressIndicator.INDETERMINATE_PROGRESS);

      // create the geoprocessing task with the service URL and load it
      GeoprocessingTask geoprocessingTask = new GeoprocessingTask("https://sampleserver6.arcgisonline" +

      geoprocessingTask.addDoneLoadingListener(() -> {
        if (geoprocessingTask.getLoadStatus() == LoadStatus.LOADED) {
          // hide the progress when the geoprocessing task is done loading and enable the click event

          mapView.setOnMouseClicked(e -> {
            // check that the primary mouse button was clicked and any previous geoprocessing job has been canceled
            if (e.isStillSincePress() && e.getButton() == MouseButton.PRIMARY && geoprocessingJob == null) {

              // show a graphic in the input graphics overlay at the clicked location
              Point2D point2D = new Point2D(e.getX(), e.getY());
              Point point = mapView.screenToLocation(point2D);
              Graphic inputGraphic = new Graphic(point);

              // get the default geoprocessing parameters
              ListenableFuture<GeoprocessingParameters> defaultParameters = geoprocessingTask.createDefaultParametersAsync();
              defaultParameters.addDoneListener(() -> {
                try {
                  GeoprocessingParameters parameters = defaultParameters.get();

                  // create required viewshed fields
                  List<Field> fields = Collections.singletonList(Field.createString("observer", "", 8));

                  // create a feature collection table (used as a parameter to the geoprocessing job)
                  final FeatureCollectionTable featureCollectionTable = new FeatureCollectionTable(fields,
                      GeometryType.POINT, point.getSpatialReference());

                  featureCollectionTable.addDoneLoadingListener(() -> {
                    // create a new feature with the geometry of the clicked location and add it to the table
                    Feature newFeature = featureCollectionTable.createFeature();

                    featureCollectionTable.addFeatureAsync(newFeature).addDoneListener(() -> {
                      // set the required parameters for viewshed
                      parameters.getInputs().put("Input_Observation_Point", new GeoprocessingFeatures(featureCollectionTable));

                      // create a geoprocessing job from the task with the parameters
                      geoprocessingJob = geoprocessingTask.createJob(parameters);

                      // start the job and wait for the result
                      geoprocessingJob.addJobDoneListener(() -> {
                        if (geoprocessingJob.getStatus() == Job.Status.SUCCEEDED) {
                          // get the viewshed from the job's result
                          GeoprocessingResult geoprocessingResult = geoprocessingJob.getResult();
                          GeoprocessingFeatures resultFeatures = (GeoprocessingFeatures) geoprocessingResult.getOutputs().get("Viewshed_Result");

                          // loop through the result features to get the viewshed geometries
                          FeatureSet featureSet = resultFeatures.getFeatures();
                          for (Feature feature : featureSet) {
                            // add the viewshed geometry as a graphic to the output graphics overlay
                            Graphic graphic = new Graphic(feature.getGeometry());
                        } else {
                          // remove the input and show an error if the job fails
                          new Alert(AlertType.ERROR, "Geoprocessing job failed. Try again.").show();
                        // hide the progress when the job is complete
                        // cancel the job if it's still going and set it to null to re-enable the mouse click listener
                        if (geoprocessingJob != null) {
                          geoprocessingJob = null;
                } catch (InterruptedException | ExecutionException ex) {
                  new Alert(AlertType.ERROR, "Error creating default geoprocessing parameters").show();
        } else {
          new Alert(AlertType.ERROR, "Failed to load geoprocessing task").show();

      // and the mapView and progress indicator to the stack pane
      stackPane.getChildren().addAll(mapView, progress);
      StackPane.setAlignment(progress, Pos.CENTER);
    } catch (Exception e) {
      // on any error, display the stack trace.

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

    if (mapView != null) {

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


In this topic
  1. Code