A map image layer may contain many sublayers such as different types of roads in a road network or city, county, and state borders in a US map. The user may only be interested in a subset of these sublayers. Or, perhaps showing all of the sublayers would show too much detail. In these cases, you can hide certain sublayers by changing their visibility.
How to use the sample
Each sublayer has a check box which can be used to toggle the visibility of the sublayer.
How it works
Create an ArcGISMapImageLayer object with the URL to a map image service.
Get the SubLayerList with mapImageLayer.getSubLayers().
For each layer in the sublayer list, set its visible property to true or false using .setVisible().
Relevant API
ArcGISMapImageLayer
SubLayerList
Tags
layer, sublayer, visibility
Sample Code
MapImageLayerSublayerVisibilitySample.java
Use dark colors for code blocksCopy
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
/*
* Copyright 2017 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.map_image_layer_sublayer_visibility;
import javafx.application.Application;
import javafx.beans.property.SimpleBooleanProperty;
import javafx.geometry.Insets;
import javafx.geometry.Pos;
import javafx.scene.Scene;
import javafx.scene.control.Alert;
import javafx.scene.control.Label;
import javafx.scene.control.ListView;
import javafx.scene.control.cell.CheckBoxListCell;
import javafx.scene.layout.Background;
import javafx.scene.layout.BackgroundFill;
import javafx.scene.layout.CornerRadii;
import javafx.scene.layout.StackPane;
import javafx.scene.layout.VBox;
import javafx.scene.paint.Paint;
import javafx.stage.Stage;
import javafx.util.StringConverter;
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
import com.esri.arcgisruntime.layers.ArcGISMapImageLayer;
import com.esri.arcgisruntime.layers.ArcGISSublayer;
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;
publicclassMapImageLayerSublayerVisibilitySampleextendsApplication{
private MapView mapView;
@Overridepublicvoidstart(Stage stage){
try {
// create a border pane and application scene StackPane stackPane = new StackPane();
Scene scene = new Scene(stackPane);
scene.getStylesheets().add(getClass().getResource("/map_image_layer_sublayer_visibility/style.css").toExternalForm());
// size the stage and add a title stage.setTitle("Map Image Layer Sublayer Visibility Sample");
stage.setWidth(800);
stage.setHeight(700);
stage.setScene(scene);
stage.show();
// 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 control panel VBox controlsVBox = new VBox(6);
controlsVBox.setBackground(new Background(new BackgroundFill(Paint.valueOf("rgba(0,0,0,0.3)"), CornerRadii.EMPTY,
Insets.EMPTY)));
controlsVBox.setPadding(new Insets(10.0));
controlsVBox.setMaxSize(180, 130);
controlsVBox.getStyleClass().add("panel-region");
// create a ListView containing a CheckBox for the visibility of each sublayervar sublayersLabel = new Label("Sublayers");
ListView<ArcGISSublayer> sublayersList = new ListView<>();
sublayersList.setCellFactory(CheckBoxListCell.forListView(
sublayer -> {
// set visibility of sublayer when checkbox is clickedvar visibleProperty = new SimpleBooleanProperty(sublayer.isVisible());
visibleProperty.addListener((observable, oldValue, newValue) -> sublayer.setVisible(newValue));
return visibleProperty;
},
new ArcGISSublayerStringConverter()));
controlsVBox.getChildren().addAll(sublayersLabel, sublayersList);
// create a map with the topographic basemap style ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
// create a map view and set the map to it mapView = new MapView();
mapView.setMap(map);
// set a viewpoint on the map view mapView.setViewpoint(new Viewpoint(48.354406, -99.998267, 147914382));
// create an image Layer with dynamically generated ArcGISMap images ArcGISMapImageLayer imageLayer = new ArcGISMapImageLayer("https://sampleserver6.arcgisonline.com/arcgis/rest/services/SampleWorldCities/MapServer");
// add the image layer to the map's operational layers map.getOperationalLayers().add(imageLayer);
// set the image layer's opacity so that the basemap is visible behind it imageLayer.setOpacity(0.7f);
// set a done-loading listener on the layer imageLayer.addDoneLoadingListener(() -> {
if (imageLayer.getLoadStatus() == LoadStatus.LOADED) {
// set the layer's sublayers on the ListView sublayersList.setItems(imageLayer.getSublayers());
} else {
// show alert if layer fails to loadnew Alert(Alert.AlertType.ERROR, "Error loading Image Layer.").show();
}
});
// add the map view and controls to the stack pane stackPane.getChildren().addAll(mapView, controlsVBox);
StackPane.setAlignment(controlsVBox, Pos.TOP_LEFT);
StackPane.setMargin(controlsVBox, new Insets(10, 0, 0, 10));
} catch (Exception e) {
// on any error, display the stack trace. e.printStackTrace();
}
}
@Overridepublicvoidstop(){
// releases resources when the application closesif (mapView != null) {
mapView.dispose();
}
}
/**
* Starting point of this application.
*
* @param args arguments to this application.
*/publicstaticvoidmain(String[] args){
Application.launch(args);
}
/**
* A StringConverter for displaying ArcGISSublayers. Simply displays the ArcGISSublayer's name.
*/privatestaticclassArcGISSublayerStringConverterextendsStringConverter<ArcGISSublayer> {
@Overridepublic String toString(ArcGISSublayer sublayer){
return sublayer.getName();
}
@Overridepublic ArcGISSublayer fromString(String string){
returnnull;
}
}
}