Group layers

View on GitHub
Sample viewer app

Group a collection of layers together and toggle their visibility as a group.

Image of group layers

Use case

Group layers communicate to the user that layers are related and can be managed together.

In a land development project, you might group layers according to the phase of development.

How to use the sample

The layers in the map will be displayed in a table of contents. Toggle the checkbox next to a layer's name to change its visibility. Turning a group layer's visibility off will override the visibility of its child layers.

How it works

  1. Create an empty GroupLayer.
  2. Add a child layer to the group layer's layers collection.
  3. Set the group layer's GroupVisibilityMode to change its behavior.
  4. GroupVisibilityMode.INDEPENDENT allows each sublayer to change its visibility independently.
  5. GroupVisibilityMode.EXCLUSIVE allows only one sublayer to be visible at a time.
  6. GroupVisibilityMode.INHERITED treats the group layer as if it is one merged layer.
  7. To toggle the visibility of the group, simply change the group layer's visibility property using layer.setVisible(boolean).

Relevant API

  • GroupLayer
  • GroupVisibilityMode

Additional information

The full extent of a group layer may change when child layers are added/removed. Group layers do not have a spatial reference, but the full extent will have the spatial reference of the first child layer.

Group layers can be saved to web scenes. In web maps, group layers will be ignored.

The implementation shown here makes use of a custom tree cell for displaying layers in a tree view. In the custom tree cell, toggling the checkbox of the group layer cell does not also toggle the child cell's checkbox. If you desire this behavior, use or extend JavaFX's CheckBoxTreeCell and CheckBoxTreeItem.

Tags

group layer, layers

Sample Code

GroupLayersSample.javaLayerTreeCell.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
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
/*
 * 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.group_layers;

import java.util.Arrays;
import java.util.List;

import javafx.application.Application;
import javafx.geometry.Insets;
import javafx.geometry.Pos;
import javafx.scene.Scene;
import javafx.scene.control.Alert;
import javafx.scene.control.ToggleGroup;
import javafx.scene.control.TreeItem;
import javafx.scene.control.TreeView;
import javafx.scene.layout.StackPane;
import javafx.stage.Stage;

import com.esri.arcgisruntime.data.ServiceFeatureTable;
import com.esri.arcgisruntime.layers.ArcGISSceneLayer;
import com.esri.arcgisruntime.layers.FeatureLayer;
import com.esri.arcgisruntime.layers.GroupLayer;
import com.esri.arcgisruntime.layers.GroupVisibilityMode;
import com.esri.arcgisruntime.layers.Layer;
import com.esri.arcgisruntime.loadable.LoadStatus;
import com.esri.arcgisruntime.mapping.ArcGISScene;
import com.esri.arcgisruntime.mapping.ArcGISTiledElevationSource;
import com.esri.arcgisruntime.mapping.Basemap;
import com.esri.arcgisruntime.mapping.Surface;
import com.esri.arcgisruntime.mapping.view.Camera;
import com.esri.arcgisruntime.mapping.view.SceneView;

public class GroupLayersSample extends Application {

  private SceneView sceneView;
  static ToggleGroup buildingsToggleGroup;

  @Override
  public void start(Stage stage) {

    try {

      // set the title and size of the stage and show it
      StackPane stackPane = new StackPane();
      Scene fxScene = new Scene(stackPane);
      stage.setTitle("Group Layers Sample");
      stage.setWidth(800);
      stage.setHeight(700);

      // create a JavaFX scene with a stackpane and set it to the stage
      stage.setScene(fxScene);
      stage.show();

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

      // create a scene with a basemap and add it to the scene view
      ArcGISScene scene = new ArcGISScene();
      scene.setBasemap(Basemap.createImagery());
      sceneView.setArcGISScene(scene);

      // set the base surface with world elevation
      Surface surface = new Surface();
      surface.getElevationSources().add(new ArcGISTiledElevationSource(
        "https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer"));
      scene.setBaseSurface(surface);

      // create a group layer for project areas, set the visibility mode and add layers to it
      GroupLayer projectAreaGroupLayer = new GroupLayer();
      projectAreaGroupLayer.setName("Project area group");
      projectAreaGroupLayer.setVisibilityMode(GroupVisibilityMode.INDEPENDENT);
      projectAreaGroupLayer.getLayers().addAll(Arrays.asList(
        (new FeatureLayer(new ServiceFeatureTable(
          "https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/DevelopmentProjectArea/FeatureServer/0"))),
        (new FeatureLayer(new ServiceFeatureTable(
          "https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/DevA_Pathways/FeatureServer/1"))),
        (new ArcGISSceneLayer(
          "https://tiles.arcgis.com/tiles/P3ePLMYs2RVChkJx/arcgis/rest/services/DevA_Trees/SceneServer"))
      ));

      // create a group layer for buildings, set the visibility mode and add layers to it
      GroupLayer buildingsGroupLayer = new GroupLayer();
      buildingsGroupLayer.setName("Buildings group");
      buildingsGroupLayer.setVisibilityMode(GroupVisibilityMode.EXCLUSIVE);
      buildingsGroupLayer.getLayers().addAll(Arrays.asList(
        (new ArcGISSceneLayer(
          "https://tiles.arcgis.com/tiles/P3ePLMYs2RVChkJx/arcgis/rest/services/DevA_BuildingShells/SceneServer")),
        (new ArcGISSceneLayer(
          "https://tiles.arcgis.com/tiles/P3ePLMYs2RVChkJx/arcgis/rest/services/DevB_BuildingShells/SceneServer"))
      ));

      // add the group layers to the scene as operational layers
      scene.getOperationalLayers().addAll(Arrays.asList(projectAreaGroupLayer, buildingsGroupLayer));

      // display an alert if the child layers in the group layers fail to load
      projectAreaGroupLayer.getLayers().forEach(childLayer ->
        childLayer.addDoneLoadingListener(() -> {
          if (childLayer.getLoadStatus() == LoadStatus.LOADED) {
            // zoom to the extent of the project area group layer when the child layers are loaded
            sceneView.setViewpointCamera(new Camera(projectAreaGroupLayer.getFullExtent().getCenter(), 700, 0, 60, 0));
          }
        })
      );

      // create a JavaFX tree view to show the layers in the scene
      TreeView<Layer> layerTreeView = new TreeView<>();
      layerTreeView.setMaxSize(250, 200);
      layerTreeView.setPadding(new Insets(10, 0, 0, 5));
      TreeItem<Layer> rootTreeItem = new TreeItem<>();
      layerTreeView.setRoot(rootTreeItem);
      layerTreeView.setShowRoot(false);
      StackPane.setAlignment(layerTreeView, Pos.TOP_RIGHT);
      StackPane.setMargin(layerTreeView, new Insets(10));
      stackPane.getChildren().add(layerTreeView);

      // create a toggle group for the tree view UI
      buildingsToggleGroup = new ToggleGroup();

      // display each layer with a custom tree cell
      layerTreeView.setCellFactory(p -> new LayerTreeCell());

      // recursively build the table of contents from the scene's operational layers
      buildLayersView(rootTreeItem, scene.getOperationalLayers());

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

  /**
   * Recursively builds a tree from a parent tree item using a list of operational layers (including group layers).
   *
   * @param parentItem tree item to build tree from
   * @param operationalLayers a list of operational layers
   */
  private void buildLayersView(TreeItem<Layer> parentItem, List<Layer> operationalLayers) {
    for (Layer layer : operationalLayers) {
      // load each layer before adding to ensure all metadata is ready for display
      layer.loadAsync();
      layer.addDoneLoadingListener(() -> {
        if (layer.getLoadStatus() == LoadStatus.LOADED) {
          // add a tree item for the layer to the parent tree item
          if (layer.canShowInLegend()) {
            TreeItem<Layer> layerItem = new TreeItem<>(layer);
            layerItem.setExpanded(true);
            parentItem.getChildren().add(layerItem);
            // if the layer is a group layer, continue building with its children
            if (layer instanceof GroupLayer && ((GroupLayer) layer).isShowChildrenInLegend()) {
              buildLayersView(layerItem, ((GroupLayer) layer).getLayers());
            }
          }
        } else new Alert(Alert.AlertType.ERROR, "Layer failed to load:\n" + layer.getLoadError().getCause().getMessage()).show();
      });
    }
  }

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

    if (sceneView != null) {
      sceneView.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.