Add a feature layer from a portal item | ArcGIS Maps SDK for Java

Learn how to use an ArcGIS portal item to access and display a feature layer 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 in a map A map is a collection of layers that are displayed in 2D. It is typically composed of a basemap layer and data layers. Learn more .

add a feature layer from a portal item

You can host a variety of geographic data and other resources using 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 . These portal items 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 can also define how the data is presented. A web map A web map is a map 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 map specification. Learn more or 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 , for example, not only defines the layers for a map A map is a collection of layers that are displayed in 2D. It is typically composed of a basemap layer and data layers. Learn more or 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 , but also how layers are symbolized, the minimum and/or maximum scales at which they display, and several other properties. Likewise, a hosted feature layer contains the data for the layer and also defines the symbols and other display properties for how it is presented. When you add a map, scene, or layer from a portal item to your app, everything that has been saved with the 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 is applied in your app. Adding portal items to your app rather than creating them programmatically saves you from writing a lot of code, and can provide consistency across apps that use the same data.

In this tutorial, you will add a hosted feature layer to display trailheads in the Santa Monica Mountains of Southern California. The hosted layer defines the trailhead locations (points) as well as the symbols used to display them.

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 this tutorial, complete the Display a map tutorial, or download and unzip the Display a map 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 IntelliJ IDEA’s 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 map tutorial so they can be used in this tutorial: you will add imports, change the application title, and modify the view point’s scale. You will then add required JavaFX controls to the build configuration.

In IntellJ IDEA, locate the Project tool window, open src/main/java/com.example.app, and double-click App. Add the following imports, replacing those from the Display a map tutorial.

In the main menu of IntelliJ IDEA, click View > Tool Windows > Project. The Project Tool window displays, with a vertical tab on the left that says Project.
Inside the Project tool window, your view name should also be Project. If the view name is something else (such as Packages or Project Files), click on the leftmost control in the title bar of the Project tool window, and select Project from the drop-down list.

Project view in Project tool window

App.java

package com.example.app;

import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
import com.esri.arcgisruntime.layers.FeatureLayer;
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.portal.Portal;
import com.esri.arcgisruntime.portal.PortalItem;

import javafx.application.Application;
import javafx.scene.control.Alert;
import javafx.scene.layout.StackPane;
import javafx.scene.Scene;
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 Add a feature layer from a portal item.

App.java

  @Override
  public void start(Stage stage) {

    // set the title and size of the stage and show it
    stage.setTitle("Add a feature layer from a portal item");

    stage.setWidth(800);
    stage.setHeight(700);
    stage.show();

Display the ArcGIS portal item

You can reference an 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 (such as a web map or feature layer) hosted in a portal (such as ArcGIS Online) using its 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 reference the Trailheads Styled feature layer stored in ArcGIS Online using its item ID: 2e4b3df6ba4b44969a3bc9827de746b3. You will then add that feature layer to your map’s collection of data layers (operational layers).

In the start() method, directly before mapView = new MapView();, create a PortalItem that references the 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 that the feature layer will use. To do this, provide the 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 and a Portal.

App.java


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

14
package com.example.app;
15

16
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
17
import com.esri.arcgisruntime.layers.FeatureLayer;
18
import com.esri.arcgisruntime.loadable.LoadStatus;
19
import com.esri.arcgisruntime.mapping.ArcGISMap;
20
import com.esri.arcgisruntime.mapping.BasemapStyle;
21
import com.esri.arcgisruntime.mapping.Viewpoint;
22
import com.esri.arcgisruntime.mapping.view.MapView;
23
import com.esri.arcgisruntime.portal.Portal;
24
import com.esri.arcgisruntime.portal.PortalItem;
25

26
import javafx.application.Application;
27
import javafx.scene.control.Alert;
28
import javafx.scene.layout.StackPane;
29
import javafx.scene.Scene;
30
import javafx.stage.Stage;
31

32
public class App extends Application {
33

34
  private MapView mapView;
35

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

40
  @Override
41
  public void start(Stage stage) {
42

43
    // set the title and size of the stage and show it
44
    stage.setTitle("Add a feature layer from a portal item");
45

46
    stage.setWidth(800);
47
    stage.setHeight(700);
48
    stage.show();
49

50
    // create a JavaFX scene with a stack pane as the root node, and add it to the scene
51
    StackPane stackPane = new StackPane();
52
    Scene scene = new Scene(stackPane);
53
    stage.setScene(scene);
54

55
    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
56

57
    // create a map view to display the map and add it to the stack pane
58
    String portalItemId = "2e4b3df6ba4b44969a3bc9827de746b3";
59
    Portal portal = new Portal("https://www.arcgis.com");
60
    PortalItem portalItem = new PortalItem(portal, portalItemId);
61

62
    mapView = new MapView();
63
    stackPane.getChildren().add(mapView);
22 collapsed lines
64

65
    ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
66
    map.getOperationalLayers().add(layer);
67

68
    // set the map on the map view
69
    mapView.setMap(map);
70

71
    mapView.setViewpoint(new Viewpoint(34.02700, -118.80543, 144447.638572));
72

73
  }
74

75
  /**
76
   * Stops and releases all resources used in application.
77
   */
78
  @Override
79
  public void stop() {
80
    if (mapView != null) {
81
      mapView.dispose();
82
    }
83
  }
84

85
}

Create a FeatureLayer passing the PortalItem and a layer ID of 0. Using a PortalItem to create a FeatureLayer causes the portal item to be loaded asynchronously.

A layer ID is required because a portal item may have more than one layer. For instance, when a feature service has 3 layers, such as trailheads (points), trails (polylines) and trail areas (polygons), the corresponding portal item would contain all three layers.
App.java
56 collapsed lines 1 // Copyright 2020 Esri 2 // Licensed under the Apache License, Version 2.0 (the "License"); 3 // you may not use this file except in compliance with the License. 4 // You may obtain a copy of the License at 5 // 6 // http://www.apache.org/licenses/LICENSE-2.0 7 // 8 // Unless required by applicable law or agreed to in writing, software 9 // distributed under the License is distributed on an "AS IS" BASIS, 10 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 11 // See the License for the specific language governing permissions and 12 // limitations under the License. 13 14 package com.example.app; 15 16 import com.esri.arcgisruntime.ArcGISRuntimeEnvironment; 17 import com.esri.arcgisruntime.layers.FeatureLayer; 18 import com.esri.arcgisruntime.loadable.LoadStatus; 19 import com.esri.arcgisruntime.mapping.ArcGISMap; 20 import com.esri.arcgisruntime.mapping.BasemapStyle; 21 import com.esri.arcgisruntime.mapping.Viewpoint; 22 import com.esri.arcgisruntime.mapping.view.MapView; 23 import com.esri.arcgisruntime.portal.Portal; 24 import com.esri.arcgisruntime.portal.PortalItem; 25 26 import javafx.application.Application; 27 import javafx.scene.control.Alert; 28 import javafx.scene.layout.StackPane; 29 import javafx.scene.Scene; 30 import javafx.stage.Stage; 31 32 public class App extends Application { 33 34 private MapView mapView; 35 36 public static void main(String[] args) { 37 Application.launch(args); 38 } 39 40 @Override 41 public void start(Stage stage) { 42 43 // set the title and size of the stage and show it 44 stage.setTitle("Add a feature layer from a portal item"); 45 46 stage.setWidth(800); 47 stage.setHeight(700); 48 stage.show(); 49 50 // create a JavaFX scene with a stack pane as the root node, and add it to the scene 51 StackPane stackPane = new StackPane(); 52 Scene scene = new Scene(stackPane); 53 stage.setScene(scene); 54 55 ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN"); 56 57 // create a map view to display the map and add it to the stack pane 58 String portalItemId = "2e4b3df6ba4b44969a3bc9827de746b3"; 59 Portal portal = new Portal("https://www.arcgis.com"); 60 PortalItem portalItem = new PortalItem(portal, portalItemId); 61 62 long layerId = 0; 63 FeatureLayer layer = new FeatureLayer(portalItem, layerId); 64 65 mapView = new MapView(); 66 stackPane.getChildren().add(mapView); 22 collapsed lines 67 68 ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC); 69 map.getOperationalLayers().add(layer); 70 71 // set the map on the map view 72 mapView.setMap(map); 73 74 mapView.setViewpoint(new Viewpoint(34.02700, -118.80543, 144447.638572)); 75 76 } 77 78 /** 79 * Stops and releases all resources used in application. 80 */ 81 @Override 82 public void stop() { 83 if (mapView != null) { 84 mapView.dispose(); 85 } 86 } 87 88 }

Add a done loading listener to the portal item. In the lambda, check if the portal item is not loaded and, in that case, display an alert.

App.java


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

14
package com.example.app;
15

16
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
17
import com.esri.arcgisruntime.layers.FeatureLayer;
18
import com.esri.arcgisruntime.loadable.LoadStatus;
19
import com.esri.arcgisruntime.mapping.ArcGISMap;
20
import com.esri.arcgisruntime.mapping.BasemapStyle;
21
import com.esri.arcgisruntime.mapping.Viewpoint;
22
import com.esri.arcgisruntime.mapping.view.MapView;
23
import com.esri.arcgisruntime.portal.Portal;
24
import com.esri.arcgisruntime.portal.PortalItem;
25

26
import javafx.application.Application;
27
import javafx.scene.control.Alert;
28
import javafx.scene.layout.StackPane;
29
import javafx.scene.Scene;
30
import javafx.stage.Stage;
31

32
public class App extends Application {
33

34
  private MapView mapView;
35

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

40
  @Override
41
  public void start(Stage stage) {
42

43
    // set the title and size of the stage and show it
44
    stage.setTitle("Add a feature layer from a portal item");
45

46
    stage.setWidth(800);
47
    stage.setHeight(700);
48
    stage.show();
49

50
    // create a JavaFX scene with a stack pane as the root node, and add it to the scene
51
    StackPane stackPane = new StackPane();
52
    Scene scene = new Scene(stackPane);
53
    stage.setScene(scene);
54

55
    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
56

57
    // create a map view to display the map and add it to the stack pane
58
    String portalItemId = "2e4b3df6ba4b44969a3bc9827de746b3";
59
    Portal portal = new Portal("https://www.arcgis.com");
60
    PortalItem portalItem = new PortalItem(portal, portalItemId);
61

62
    long layerId = 0;
63
    FeatureLayer layer = new FeatureLayer(portalItem, layerId);
64

65
    mapView = new MapView();
66
    stackPane.getChildren().add(mapView);
67

68
    ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
69
    map.getOperationalLayers().add(layer);
70

71
    // set the map on the map view
72
    mapView.setMap(map);
73

74
    mapView.setViewpoint(new Viewpoint(34.02700, -118.80543, 144447.638572));
75

76
    portalItem.addDoneLoadingListener(() -> {
77
      if (portalItem.getLoadStatus() != LoadStatus.LOADED) {
78
        new Alert(Alert.AlertType.ERROR, "Portal item not loaded. " + portalItem.getLoadError().getCause().getMessage()).show();
79
      }
80
    });
81

82
  }
12 collapsed lines
83

84
  /**
85
   * Stops and releases all resources used in application.
86
   */
87
  @Override
88
  public void stop() {
89
    if (mapView != null) {
90
      mapView.dispose();
91
    }
92
  }
93

94
}

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.

You should see a map of trail heads in the Santa Monica mountains. Click, drag, and scroll the mouse wheel on the map view to explore the map.

What’s next?

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

TutorialsAdd a feature layer NextStyles and data visualization