Display a web scene | ArcGIS Maps SDK for Java

Learn how to create and display a scene A scene is a collection of layers that are displayed in 3D. It is typically composed of a basemap layer, data layers, and 3D data. Learn more from a web scene A web scene is a scene stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web scene specification. Learn more stored in ArcGIS.

display a web scene

This tutorial shows you how to create and display a scene A scene is a collection of layers that are displayed in 3D. It is typically composed of a basemap layer, data layers, and 3D data. Learn more from a web scene A web scene is a scene stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web scene specification. Learn more . All web scenes are stored in ArcGIS with a unique item ID An item ID is a unique identifier representing a single item stored, managed, and accessed in a portal, such as a web map, hosted layer, or file. Learn more . You will access an existing web scene by item ID and display its layers. The web scene contains feature layers A feature layer (client-side) is a data layer that can access and display features from a feature service that has the same type of geometry and attribute fields. Learn more for the Santa Monica Mountains in California.

Prerequisites

Before starting this tutorial:

You need an ArcGIS Location Platform or ArcGIS Online account.
Confirm that your system meets the minimum system requirements.
An IDE for Java.

Steps

Open a Java project with Gradle

To start the tutorial, complete the Display a scene tutorial, or download and unzip the Display a scene solution into a new folder.
Open the build.gradle file as a project in IntelliJ IDEA.
If you downloaded the solution, get an access token and set the API key.
An API key An API key is a long-lived access token created using API key credentials. They are valid for up to one year and are typically embedded directly into client applications. Learn more gives your app access to secure resources A secure resource is any item or service in an ArcGIS that requires an ArcGIS account and authentication to access. Examples include ArcGIS Location Services, and items and data services in an ArcGIS portal. Learn more used in this tutorial.

Go to the Create an API key tutorial to obtain a new API key access token An access token is an authorization string that provides access to secure ArcGIS content, data, and services. Its capabilities are determined by the privileges it supports. It is obtained by implementing API key authentication, User authentication, or App authentication. Learn more using your ArcGIS Location Platform An ArcGIS Location Platform account, formerly known as an ArcGIS Developer account, is an identity associated with an ArcGIS Location Platform subscription. Learn more or ArcGIS Online An ArcGIS Online account, also known as an ArcGIS Organization account, is an identity associated with an ArcGIS Online subscription. It can be used to access ArcGIS tools and develop applications with ArcGIS location services for an organization. Learn more account. Ensure that the following privilege Privileges are a set of permissions assigned to ArcGIS accounts, developer credentials, and applications that grant access to secure resources and functionality in ArcGIS. Learn more is enabled: Location services > Basemaps > Basemap styles service. Copy the access token as it will be used in the next step.

In the IntelliJ IDEA > Project tool window, open src/main/java/com.example.app and double-click App.

In the start() method, set the API key property on the ArcGISRuntimeEnvironment with your access token An access token is an authorization string that provides access to secure ArcGIS content, data, and services. Its capabilities are determined by the privileges it supports. It is obtained by implementing API key authentication, User authentication, or App authentication. Learn more . Replace YOUR_ACCESS_TOKEN with your copied access token. Be sure to surround your access token with double quotes as it is a string.

App.java

ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");

Warning

The access token is stored directly in the code as a convenience for this tutorial. Storing access tokens in the source code is not best practice.

Prepare files before coding the app

Modify the files from the Display a scene tutorial so that they can be used in this tutorial: you will add imports, change the application title, and remove unnecessary code.

In IntelliJ IDEA’s Project tool window, open src/main/java/com.example.app and double-click App.

Add the following imports, replacing those from the Display a scene tutorial.

App.java

package com.example.app;

import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
import com.esri.arcgisruntime.mapping.ArcGISScene;
import com.esri.arcgisruntime.mapping.view.SceneView;
import com.esri.arcgisruntime.portal.Portal;
import com.esri.arcgisruntime.portal.PortalItem;

import javafx.application.Application;
import javafx.scene.Scene;
import javafx.scene.layout.StackPane;
import javafx.stage.Stage;

public class App extends Application {

In the start() life-cycle method, change the title that will appear on the application window to Display a web scene tutorial.

App.java

34 collapsed lines
//   Copyright 2021 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.example.app;

import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
import com.esri.arcgisruntime.mapping.ArcGISScene;
import com.esri.arcgisruntime.mapping.view.SceneView;
import com.esri.arcgisruntime.portal.Portal;
import com.esri.arcgisruntime.portal.PortalItem;

import javafx.application.Application;
import javafx.scene.Scene;
import javafx.scene.layout.StackPane;
import javafx.stage.Stage;

public class App extends Application {

  private SceneView sceneView;

  public static void main(String[] args) {
    Application.launch(args);
  }

  @Override
  public void start(Stage stage) {

    // set the title and size of the stage and show it
    stage.setTitle("Display a web scene tutorial");

    stage.setWidth(800);
    stage.setHeight(700);
    stage.show();
29 collapsed lines

    // create a JavaFX scene with a stack pane as the root node, and add it to the scene
    StackPane stackPane = new StackPane();
    Scene fxScene = new Scene(stackPane);

    stage.setScene(fxScene);

    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");

    // create a scene view to display the scene and add it to the stack pane
    sceneView = new SceneView();
    stackPane.getChildren().add(sceneView);

    // set the scene on the scene view
    sceneView.setArcGISScene(scene);

  }

  /**
   * Stops and releases all resources used in application.
   */
  @Override
  public void stop() {
    if (sceneView != null) {
      sceneView.dispose();
    }
  }

}

In start() method, delete the code for base surface, surface elevation, camera, and camera viewpoint. The web scene defines these characteristics, so you don’t have to set them in your app.

App.java

55 collapsed lines
//   Copyright 2021 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.example.app;

import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
import com.esri.arcgisruntime.geometry.Point;
import com.esri.arcgisruntime.geometry.SpatialReferences;
import com.esri.arcgisruntime.mapping.ArcGISScene;
import com.esri.arcgisruntime.mapping.ArcGISTiledElevationSource;
import com.esri.arcgisruntime.mapping.BasemapStyle;
import com.esri.arcgisruntime.mapping.Surface;
import com.esri.arcgisruntime.mapping.view.Camera;
import com.esri.arcgisruntime.mapping.view.SceneView;

import javafx.application.Application;
import javafx.scene.Scene;
import javafx.scene.layout.StackPane;
import javafx.stage.Stage;

public class App extends Application {

  private SceneView sceneView;

  public static void main(String[] args) {
    Application.launch(args);
  }

  @Override
  public void start(Stage stage) {

    // set the title and size of the stage and show it
    stage.setTitle("Display a scene tutorial");
    stage.setWidth(800);
    stage.setHeight(700);
    stage.show();

    // create a JavaFX scene with a stack pane as the root node, and add it to the scene
    StackPane stackPane = new StackPane();
    Scene fxScene = new Scene(stackPane);

    stage.setScene(fxScene);

    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");

    // create a scene view to display the scene and add it to the stack pane
    sceneView = new SceneView();
    stackPane.getChildren().add(sceneView);

    ArcGISScene scene = new ArcGISScene(BasemapStyle.ARCGIS_IMAGERY_STANDARD);

    // set the scene on the scene view
    sceneView.setArcGISScene(scene);

    // add base surface for elevation data
    Surface surface = new Surface();
    String elevationServiceUrl = "https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer";
    surface.getElevationSources().add(new ArcGISTiledElevationSource(elevationServiceUrl));
    // add an exaggeration factor to increase the 3D effect of the elevation.
    surface.setElevationExaggeration(2.5f);

    scene.setBaseSurface(surface);

    Point cameraLocation = new Point(-118.794, 33.909, 5330.0, SpatialReferences.getWgs84());
    Camera camera = new Camera(cameraLocation, 355.0, 72.0, 0.0);
    sceneView.setViewpointCamera(camera);
14 collapsed lines

  }

  /**
   * Stops and releases all resources used in application.
   */
  @Override
  public void stop() {
    if (sceneView != null) {
      sceneView.dispose();
    }
  }

}

In start() method, delete the code that creates an ArcGISScene by passing a basemap. In this tutorial, you will instead pass a portal item.

App.java

55 collapsed lines
//   Copyright 2021 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.example.app;

import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
import com.esri.arcgisruntime.geometry.Point;
import com.esri.arcgisruntime.geometry.SpatialReferences;
import com.esri.arcgisruntime.mapping.ArcGISScene;
import com.esri.arcgisruntime.mapping.ArcGISTiledElevationSource;
import com.esri.arcgisruntime.mapping.BasemapStyle;
import com.esri.arcgisruntime.mapping.Surface;
import com.esri.arcgisruntime.mapping.view.Camera;
import com.esri.arcgisruntime.mapping.view.SceneView;

import javafx.application.Application;
import javafx.scene.Scene;
import javafx.scene.layout.StackPane;
import javafx.stage.Stage;

public class App extends Application {

  private SceneView sceneView;

  public static void main(String[] args) {
    Application.launch(args);
  }

  @Override
  public void start(Stage stage) {

    // set the title and size of the stage and show it
    stage.setTitle("Display a scene tutorial");
    stage.setWidth(800);
    stage.setHeight(700);
    stage.show();

    // create a JavaFX scene with a stack pane as the root node, and add it to the scene
    StackPane stackPane = new StackPane();
    Scene fxScene = new Scene(stackPane);

    stage.setScene(fxScene);

    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");

    // create a scene view to display the scene and add it to the stack pane
    sceneView = new SceneView();
    stackPane.getChildren().add(sceneView);

    ArcGISScene scene = new ArcGISScene(BasemapStyle.ARCGIS_IMAGERY_STANDARD);

    // set the scene on the scene view
    sceneView.setArcGISScene(scene);

13 collapsed lines
  }

  /**
   * Stops and releases all resources used in application.
   */
  @Override
  public void stop() {
    if (sceneView != null) {
      sceneView.dispose();
    }
  }

}

Get the web scene item ID

You can use ArcGIS tools Tools, also known as developer tools, are ArcGIS software applications such as portal and ArcGIS Pro that developers can use to prepare content and data for custom applications they are building. Learn more to create and view web scenes A web scene is a scene stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web scene specification. Learn more . Use the Scene Viewer Scene Viewer(™) is a browser-based mapping tool that can view, create, and save web scenes. Learn more to identify the web scene item ID An item ID is a unique identifier representing a single item stored, managed, and accessed in a portal, such as a web map, hosted layer, or file. Learn more . This item ID will be used later in the tutorial.

Go to the LA Trails and Parks web scene in the Scene Viewer in ArcGIS Online ArcGIS Online is a GIS mapping, analytics, data hosting, and content management software as a service (SaaS) product. It includes applications, tools, APIs, and location services for users and developers. It is subscription-based and requires an ArcGIS Online account. Learn more . This web scene displays trails, trailheads and parks in the Santa Monica Mountains.
Make a note of the item ID at the end of the browser’s URL. The item ID should be 579f97b2f3b94d4a8e48a5f140a6639b.

Display the web scene

You can display a web scene A web scene is a scene stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web scene specification. Learn more using the web scene’s item ID An item ID is a unique identifier representing a single item stored, managed, and accessed in a portal, such as a web map, hosted layer, or file. Learn more . Create a scene A scene is a collection of layers that are displayed in 3D. It is typically composed of a basemap layer, data layers, and 3D data. Learn more from the web scene portal item An item, also known as a content item, is a resource stored in a portal such as a web map, hosted layer, style, script tool, file, or notebook. Learn more , and display it in your app.

In the start() method, create a new Portal(java.lang.String,boolean) referencing ArcGIS Online ArcGIS Online is a GIS mapping, analytics, data hosting, and content management software as a service (SaaS) product. It includes applications, tools, APIs, and location services for users and developers. It is subscription-based and requires an ArcGIS Online account. Learn more as the portalUrl parameter and false for the loginRequired parameter.

App.java


52 collapsed lines
2
//   Copyright 2021 Esri
3
//   Licensed under the Apache License, Version 2.0 (the "License");
4
//   you may not use this file except in compliance with the License.
5
//   You may obtain a copy of the License at
6
//
7
//   http://www.apache.org/licenses/LICENSE-2.0
8
//
9
//   Unless required by applicable law or agreed to in writing, software
10
//   distributed under the License is distributed on an "AS IS" BASIS,
11
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
//   See the License for the specific language governing permissions and
13
//   limitations under the License.
14

15
package com.example.app;
16

17
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
18
import com.esri.arcgisruntime.mapping.ArcGISScene;
19
import com.esri.arcgisruntime.mapping.view.SceneView;
20
import com.esri.arcgisruntime.portal.Portal;
21
import com.esri.arcgisruntime.portal.PortalItem;
22

23
import javafx.application.Application;
24
import javafx.scene.Scene;
25
import javafx.scene.layout.StackPane;
26
import javafx.stage.Stage;
27

28
public class App extends Application {
29

30
  private SceneView sceneView;
31

32
  public static void main(String[] args) {
33
    Application.launch(args);
34
  }
35

36
  @Override
37
  public void start(Stage stage) {
38

39
    // set the title and size of the stage and show it
40
    stage.setTitle("Display a web scene tutorial");
41

42
    stage.setWidth(800);
43
    stage.setHeight(700);
44
    stage.show();
45

46
    // create a JavaFX scene with a stack pane as the root node, and add it to the scene
47
    StackPane stackPane = new StackPane();
48
    Scene fxScene = new Scene(stackPane);
49

50
    stage.setScene(fxScene);
51

52
    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
53

54
    // create a scene view to display the scene and add it to the stack pane
55
    sceneView = new SceneView();
56
    stackPane.getChildren().add(sceneView);
57

58
    // create a scene from a web scene portal item and set it to the scene view
59

60
    Portal portal = new Portal("http://www.arcgis.com/", false);
61

62
    // set the scene on the scene view
63
    sceneView.setArcGISScene(scene);
14 collapsed lines
64

65
  }
66

67
  /**
68
   * Stops and releases all resources used in application.
69
   */
70
  @Override
71
  public void stop() {
72
    if (sceneView != null) {
73
      sceneView.dispose();
74
    }
75
  }
76

77
}

Create a PortalItem for the web scene A web scene is a scene stored as a JSON object that defines properties such as the basemap layer, data layers, layer styles, and pop-up styles. Its JSON structure is defined by the web scene specification. Learn more by passing the portal and the web scene’s item ID An item ID is a unique identifier representing a single item stored, managed, and accessed in a portal, such as a web map, hosted layer, or file. Learn more as parameters.

Create an ArcGISScene(com.esri.arcgisruntime.portal.PortalItem) using the portalItem as the constructor parameter.

App.java


52 collapsed lines
2
//   Copyright 2021 Esri
3
//   Licensed under the Apache License, Version 2.0 (the "License");
4
//   you may not use this file except in compliance with the License.
5
//   You may obtain a copy of the License at
6
//
7
//   http://www.apache.org/licenses/LICENSE-2.0
8
//
9
//   Unless required by applicable law or agreed to in writing, software
10
//   distributed under the License is distributed on an "AS IS" BASIS,
11
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
//   See the License for the specific language governing permissions and
13
//   limitations under the License.
14

15
package com.example.app;
16

17
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
18
import com.esri.arcgisruntime.mapping.ArcGISScene;
19
import com.esri.arcgisruntime.mapping.view.SceneView;
20
import com.esri.arcgisruntime.portal.Portal;
21
import com.esri.arcgisruntime.portal.PortalItem;
22

23
import javafx.application.Application;
24
import javafx.scene.Scene;
25
import javafx.scene.layout.StackPane;
26
import javafx.stage.Stage;
27

28
public class App extends Application {
29

30
  private SceneView sceneView;
31

32
  public static void main(String[] args) {
33
    Application.launch(args);
34
  }
35

36
  @Override
37
  public void start(Stage stage) {
38

39
    // set the title and size of the stage and show it
40
    stage.setTitle("Display a web scene tutorial");
41

42
    stage.setWidth(800);
43
    stage.setHeight(700);
44
    stage.show();
45

46
    // create a JavaFX scene with a stack pane as the root node, and add it to the scene
47
    StackPane stackPane = new StackPane();
48
    Scene fxScene = new Scene(stackPane);
49

50
    stage.setScene(fxScene);
51

52
    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
53

54
    // create a scene view to display the scene and add it to the stack pane
55
    sceneView = new SceneView();
56
    stackPane.getChildren().add(sceneView);
57

58
    // create a scene from a web scene portal item and set it to the scene view
59

60
    Portal portal = new Portal("http://www.arcgis.com/", false);
61

62
    PortalItem portalItem = new PortalItem(portal, "579f97b2f3b94d4a8e48a5f140a6639b");
63

64
    ArcGISScene scene = new ArcGISScene(portalItem);
65

66
    // set the scene on the scene view
67
    sceneView.setArcGISScene(scene);
14 collapsed lines
68

69
  }
70

71
  /**
72
   * Stops and releases all resources used in application.
73
   */
74
  @Override
75
  public void stop() {
76
    if (sceneView != null) {
77
      sceneView.dispose();
78
    }
79
  }
80

81
}

Use the existing code to display the new ArcGISScene(com.esri.arcgisruntime.portal.PortalItem) on the sceneView with setArcGISScene().

App.java


52 collapsed lines
2
//   Copyright 2021 Esri
3
//   Licensed under the Apache License, Version 2.0 (the "License");
4
//   you may not use this file except in compliance with the License.
5
//   You may obtain a copy of the License at
6
//
7
//   http://www.apache.org/licenses/LICENSE-2.0
8
//
9
//   Unless required by applicable law or agreed to in writing, software
10
//   distributed under the License is distributed on an "AS IS" BASIS,
11
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
//   See the License for the specific language governing permissions and
13
//   limitations under the License.
14

15
package com.example.app;
16

17
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
18
import com.esri.arcgisruntime.mapping.ArcGISScene;
19
import com.esri.arcgisruntime.mapping.view.SceneView;
20
import com.esri.arcgisruntime.portal.Portal;
21
import com.esri.arcgisruntime.portal.PortalItem;
22

23
import javafx.application.Application;
24
import javafx.scene.Scene;
25
import javafx.scene.layout.StackPane;
26
import javafx.stage.Stage;
27

28
public class App extends Application {
29

30
  private SceneView sceneView;
31

32
  public static void main(String[] args) {
33
    Application.launch(args);
34
  }
35

36
  @Override
37
  public void start(Stage stage) {
38

39
    // set the title and size of the stage and show it
40
    stage.setTitle("Display a web scene tutorial");
41

42
    stage.setWidth(800);
43
    stage.setHeight(700);
44
    stage.show();
45

46
    // create a JavaFX scene with a stack pane as the root node, and add it to the scene
47
    StackPane stackPane = new StackPane();
48
    Scene fxScene = new Scene(stackPane);
49

50
    stage.setScene(fxScene);
51

52
    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
53

54
    // create a scene view to display the scene and add it to the stack pane
55
    sceneView = new SceneView();
56
    stackPane.getChildren().add(sceneView);
57

58
    // create a scene from a web scene portal item and set it to the scene view
59

60
    Portal portal = new Portal("http://www.arcgis.com/", false);
61

62
    PortalItem portalItem = new PortalItem(portal, "579f97b2f3b94d4a8e48a5f140a6639b");
63

64
    ArcGISScene scene = new ArcGISScene(portalItem);
65

66
    // set the scene on the scene view
67
    sceneView.setArcGISScene(scene);
14 collapsed lines
68

69
  }
70

71
  /**
72
   * Stops and releases all resources used in application.
73
   */
74
  @Override
75
  public void stop() {
76
    if (sceneView != null) {
77
      sceneView.dispose();
78
    }
79
  }
80

81
}

Run the app. Ensure to run the app as a Gradle task and not as an application in your IDE. In the Gradle tool window, under Tasks > application, double-click run.

Your app should display the scene that you viewed earlier in the Scene Viewer.

What’s Next?

Learn how to use additional API features, ArcGIS location services, and ArcGIS tools in these tutorials:

TutorialsDisplay a scene NextLayers