Display subtype feature layer

View on GitHub
Sample viewer app

Displays a composite layer of all the subtype values in a feature class.

Image of display subtype feature layer

Use case

This is useful for controlling labeling, visibility and symbology of a given subtype as though they are distinct layers on the map.

How to use the sample

The sample loads with the sublayer visible on the map. Toggle its visibility with the "Show sublayer" checkbox. Change the sublayer's renderer with the radio buttons, using "Show original renderer" or "Show alternative renderer", and set its minimum scale using the "Set sublayer minimum scale" button. This will set the sublayer's minimum scale to that of the current map scale. Zoom in and out to see the sublayer become visible based on its new scale range.

How it works

  1. Create a SubtypeFeatureLayer from a ServiceFeatureTable that defines a subtype, and add it to the ArcGISMap.
  2. Get a SubtypeSublayer from the subtype feature using its name.
  3. Enable the sublayer's labels and define them with a LabelDefinition.
  4. Set the visibility status using this sublayer's IsVisible property.
  5. Change the sublayer's symbology with .setRenderer(Renderer).
  6. Update the sublayer's minimum scale value with .setMinScale().

Relevant API

  • LabelDefinition
  • ServiceFeatureTable
  • SimpleLabelExpression
  • SubtypeFeatureLayer
  • SubtypeSublayer

About the data

The feature service layer in this sample represents an electric network in Naperville, Illinois, which contains a utility network with asset classification for different devices.

Tags

asset group, feature layer, labeling, sublayer, subtype, symbology, utility network, visible scale range

Sample Code

DisplaySubtypeFeatureLayerController.javaDisplaySubtypeFeatureLayerSample.javamain.fxml
                                                                                                                                                                             
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
167
168
169
170
171
172
173
/*
 * Copyright 2019 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_subtype_feature_layer;

import javafx.fxml.FXML;
import javafx.scene.control.Alert;
import javafx.scene.control.CheckBox;
import javafx.scene.control.Label;
import javafx.scene.layout.VBox;
import javafx.scene.paint.Color;

import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
import com.esri.arcgisruntime.arcgisservices.LabelDefinition;
import com.esri.arcgisruntime.arcgisservices.LabelingPlacement;
import com.esri.arcgisruntime.data.ServiceFeatureTable;
import com.esri.arcgisruntime.geometry.Envelope;
import com.esri.arcgisruntime.geometry.SpatialReferences;
import com.esri.arcgisruntime.layers.SubtypeFeatureLayer;
import com.esri.arcgisruntime.layers.SubtypeSublayer;
import com.esri.arcgisruntime.loadable.LoadStatus;
import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.BasemapStyle;
import com.esri.arcgisruntime.mapping.labeling.SimpleLabelExpression;
import com.esri.arcgisruntime.mapping.Viewpoint;
import com.esri.arcgisruntime.mapping.view.MapView;
import com.esri.arcgisruntime.security.UserCredential;
import com.esri.arcgisruntime.symbology.ColorUtil;
import com.esri.arcgisruntime.symbology.Renderer;
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
import com.esri.arcgisruntime.symbology.SimpleRenderer;
import com.esri.arcgisruntime.symbology.Symbol;
import com.esri.arcgisruntime.symbology.TextSymbol;

public class DisplaySubtypeFeatureLayerController {

  @FXML private MapView mapView;
  @FXML private Label currentMapScaleLabel;
  @FXML private Label minScaleLabel;
  @FXML private CheckBox sublayerVisibilityCheckbox;
  @FXML private VBox vBox;

  private Renderer originalRenderer;
  private Renderer alternativeRenderer;
  private SubtypeSublayer sublayer;

  public void initialize() {

    try {
      // 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 map with the streets night basemap style and add it to the map view
      ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_STREETS_NIGHT);
      mapView.setMap(map);
      // display the current map scale
      mapView.addMapScaleChangedListener(mapScaleChangedEvent ->
        currentMapScaleLabel.setText("Current map scale: 1:" + Math.round(mapView.getMapScale())));

      // set a viewpoint on the map view, to Naperville, Illinois
      Viewpoint initialViewpoint = new Viewpoint(new Envelope(-9812691.11079696, 5128687.20710657,
        -9812377.9447607, 5128865.36767282, SpatialReferences.getWebMercator()));
      mapView.setViewpoint(initialViewpoint);

      // create a subtype feature layer from the service feature table, and add it to the map
      ServiceFeatureTable serviceFeatureTable = new ServiceFeatureTable(
        "https://sampleserver7.arcgisonline.com/server/rest/services/UtilityNetwork/NapervilleElectric/FeatureServer/0");

      // set user credentials to authenticate with the service
      UserCredential userCredential = new UserCredential("viewer01", "I68VGU^nMurF");
      serviceFeatureTable.setCredential(userCredential);

      SubtypeFeatureLayer subtypeFeatureLayer = new SubtypeFeatureLayer(serviceFeatureTable);
      map.getOperationalLayers().add(subtypeFeatureLayer);

      // create a text symbol for styling the sublayer label definition
      var textSymbol = new TextSymbol();
      textSymbol.setSize(12);
      textSymbol.setOutlineColor(ColorUtil.colorToArgb(Color.WHITE));
      textSymbol.setColor(ColorUtil.colorToArgb(Color.BLUE));
      textSymbol.setHaloColor(ColorUtil.colorToArgb(Color.WHITE));
      textSymbol.setHaloWidth(3);

      // create a label definition with a simple label expression
      var simpleLabelExpression = new SimpleLabelExpression("[nominalvoltage]");
      var labelDefinition = new LabelDefinition(simpleLabelExpression, textSymbol);
      labelDefinition.setPlacement(LabelingPlacement.POINT_ABOVE_RIGHT);
      labelDefinition.setUseCodedValues(true);

      // load the subtype feature layer
      subtypeFeatureLayer.loadAsync();
      subtypeFeatureLayer.addDoneLoadingListener(() -> {
        if (subtypeFeatureLayer.getLoadStatus() == LoadStatus.LOADED) {
          // show the UI for interaction with the sublayer once it has loaded
          vBox.setVisible(true);

          // get the Street Light sublayer and define its labels
          sublayer = subtypeFeatureLayer.getSublayerWithSubtypeName("Street Light");
          sublayer.setLabelsEnabled(true);
          sublayer.getLabelDefinitions().add(labelDefinition);

          // get the original renderer of the sublayer (white and black circular icon)
          originalRenderer = sublayer.getRenderer();
          // create a custom renderer for the sublayer (light pink diamond symbol)
          Symbol symbol = new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.DIAMOND, 0xfff58f84, 20);
          alternativeRenderer = new SimpleRenderer(symbol);
        } else {
          new Alert(Alert.AlertType.ERROR, "Failed to load feature layer").show();
        }
      });

    } catch (Exception e) {
      // on any error, display the stack trace.
      e.printStackTrace();
    }
  }

  /**
   * Sets the minimum scale of the labels for the sublayer.
   */
  @FXML
  private void handleMinScaleButtonClicked() {
    sublayer.setMinScale(mapView.getMapScale());
    minScaleLabel.setText("Sublayer min scale: 1:" + Math.round(sublayer.getMinScale()));
  }

  /**
   * Sets the visibility of the sublayer.
   */
  @FXML
  private void handleSublayerVisibility() {
    sublayer.setVisible(sublayerVisibilityCheckbox.isSelected());
  }

  /**
   * Sets the renderer of the sublayer to its original format (a white and black circular icon).
   */
  @FXML
  private void handleOriginalRendererButtonClicked() {
    sublayer.setRenderer(originalRenderer);
  }

  /**
   * Sets the renderer of the sublayer to that of a pink diamond symbol.
   */
  @FXML
  private void handleAlternativeRendererButtonClicked() {
    sublayer.setRenderer(alternativeRenderer);
  }

  /**
   * Disposes application resources.
   */
  void terminate() {
    if (mapView != null) {
      mapView.dispose();
    }
  }

}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.